aftership-tracking-sdk 7.0.0 → 8.0.0

data/lib/aftership-tracking-sdk/api/notification.rb

@@ -1,403 +0,0 @@
-# This code was auto generated by AfterShip SDK Generator.
-# Do not edit the class manually.
-require 'cgi'
-
-module AftershipAPI
-  class NotificationApi 
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-
-    # add_notification_by_slug_tracking_number
-    # Add notification receivers to a tracking number.
-    # @param slug [String] Tracking slug
-    # @param tracking_number [String] Tracking number
-
-    # @param body [Model::NotificationRequestV1] 
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :tracking_account_number Additional field required by some carriers to retrieve the tracking info. The shipper’s carrier account number. Refer to our article on  for more details.
-    # @option opts [String] :tracking_origin_country Additional field required by some carriers to retrieve the tracking info. The origin country/region of the shipment. Refer to our article on  for more details.
-    # @option opts [String] :tracking_destination_country Additional field required by some carriers to retrieve the tracking info. The destination country/region of the shipment. Refer to our article on  for more details.
-    # @option opts [String] :tracking_key Additional field required by some carriers to retrieve the tracking info. A type of tracking credential required by some carriers. Refer to our article on  for more details.
-    # @option opts [String] :tracking_postal_code Additional field required by some carriers to retrieve the tracking info. The postal code of the recipient’s address. Refer to our article on  for more details.
-    # @option opts [String] :tracking_ship_date Additional field required by some carriers to retrieve the tracking info. The date the shipment was sent, using the format YYYYMMDD. Refer to our article on  for more details.
-    # @option opts [String] :tracking_state Additional field required by some carriers to retrieve the tracking info. The state/province of the recipient’s address. Refer to our article on  for more details.
-    # @return [Model::Notification] 
-    def add_notification_by_slug_tracking_number(slug:, tracking_number:, body:, opts: {})
-      if "notification" != ""
-        body = { :'notification' => body }
-      end
-      opts[:body] = body
-      data, _status_code, _headers = add_notification_by_slug_tracking_number_with_http_info(slug: slug, tracking_number: tracking_number, opts: opts)
-      data
-    end
-
-    def add_notification_by_slug_tracking_number_with_http_info(slug:, tracking_number:, opts: {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: NotificationApi.add_notification_by_slug_tracking_number ...'
-      end
-
-      if slug.nil? || (slug.to_s == '')
-        raise InvalidParamError.new "slug cannot be nil or empty"
-      end
-      if tracking_number.nil? || (tracking_number.to_s == '')
-        raise InvalidParamError.new "tracking_number cannot be nil or empty"
-      end
-
-
-      # resource path
-      local_var_path = "/tracking/2024-04/notifications/#{slug}/#{tracking_number}/add" 
-      method = :'POST'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'tracking_account_number'] = opts[:'tracking_account_number'] if !opts[:'tracking_account_number'].nil?
-      query_params[:'tracking_origin_country'] = opts[:'tracking_origin_country'] if !opts[:'tracking_origin_country'].nil?
-      query_params[:'tracking_destination_country'] = opts[:'tracking_destination_country'] if !opts[:'tracking_destination_country'].nil?
-      query_params[:'tracking_key'] = opts[:'tracking_key'] if !opts[:'tracking_key'].nil?
-      query_params[:'tracking_postal_code'] = opts[:'tracking_postal_code'] if !opts[:'tracking_postal_code'].nil?
-      query_params[:'tracking_ship_date'] = opts[:'tracking_ship_date'] if !opts[:'tracking_ship_date'].nil?
-      query_params[:'tracking_state'] = opts[:'tracking_state'] if !opts[:'tracking_state'].nil?
-      # header parameters
-      header_params = opts[:header_params] || {}
-
-      # http body (model)
-      post_body = opts[:body]
-
-      # return_type
-      return_type = 'Notification'
-      
-      new_options = opts.merge(
-        :operation => :"NotificationApi.add_notification_by_slug_tracking_number",
-        :header_params => header_params,
-        :query_params => query_params,
-        :body => post_body,
-        :return_type => return_type,
-        :response_legacy_tag => "notification",
-        :is_paging => false
-      )
-
-      data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: NotificationApi#add_notification_by_slug_tracking_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end 
-
-    # add_notification_by_tracking_id
-    # Add notification receivers to a tracking number.
-    # @param tracking_id [String] tracking id
-
-    # @param body [Model::NotificationRequestV1] 
-    # @param [Hash] opts the optional parameters
-    # @return [Model::Notification] 
-    def add_notification_by_tracking_id(tracking_id:, body:, opts: {})
-      if "notification" != ""
-        body = { :'notification' => body }
-      end
-      opts[:body] = body
-      data, _status_code, _headers = add_notification_by_tracking_id_with_http_info(tracking_id: tracking_id, opts: opts)
-      data
-    end
-
-    def add_notification_by_tracking_id_with_http_info(tracking_id:, opts: {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: NotificationApi.add_notification_by_tracking_id ...'
-      end
-
-      if tracking_id.nil? || (tracking_id.to_s == '')
-        raise InvalidParamError.new "tracking_id cannot be nil or empty"
-      end
-
-
-      # resource path
-      local_var_path = "/tracking/2024-04/notifications/#{tracking_id}/add" 
-      method = :'POST'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      # header parameters
-      header_params = opts[:header_params] || {}
-
-      # http body (model)
-      post_body = opts[:body]
-
-      # return_type
-      return_type = 'Notification'
-      
-      new_options = opts.merge(
-        :operation => :"NotificationApi.add_notification_by_tracking_id",
-        :header_params => header_params,
-        :query_params => query_params,
-        :body => post_body,
-        :return_type => return_type,
-        :response_legacy_tag => "notification",
-        :is_paging => false
-      )
-
-      data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: NotificationApi#add_notification_by_tracking_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end 
-
-    # delete_notification_by_slug_tracking_number
-    # Remove notification receivers from a tracking number.
-    # @param slug [String] Tracking slug
-    # @param tracking_number [String] Tracking number
-
-    # @param body [Model::NotificationRequestV1] 
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :tracking_account_number Additional field required by some carriers to retrieve the tracking info. The shipper’s carrier account number. Refer to our article on  for more details.
-    # @option opts [String] :tracking_origin_country Additional field required by some carriers to retrieve the tracking info. The origin country/region of the shipment. Refer to our article on  for more details.
-    # @option opts [String] :tracking_destination_country Additional field required by some carriers to retrieve the tracking info. The destination country/region of the shipment. Refer to our article on  for more details.
-    # @option opts [String] :tracking_key Additional field required by some carriers to retrieve the tracking info. A type of tracking credential required by some carriers. Refer to our article on  for more details.
-    # @option opts [String] :tracking_postal_code Additional field required by some carriers to retrieve the tracking info. The postal code of the recipient’s address. Refer to our article on  for more details.
-    # @option opts [String] :tracking_ship_date Additional field required by some carriers to retrieve the tracking info. The date the shipment was sent, using the format YYYYMMDD. Refer to our article on  for more details.
-    # @option opts [String] :tracking_state Additional field required by some carriers to retrieve the tracking info. The state/province of the recipient’s address. Refer to our article on  for more details.
-    # @return [Model::Notification] 
-    def delete_notification_by_slug_tracking_number(slug:, tracking_number:, body:, opts: {})
-      if "notification" != ""
-        body = { :'notification' => body }
-      end
-      opts[:body] = body
-      data, _status_code, _headers = delete_notification_by_slug_tracking_number_with_http_info(slug: slug, tracking_number: tracking_number, opts: opts)
-      data
-    end
-
-    def delete_notification_by_slug_tracking_number_with_http_info(slug:, tracking_number:, opts: {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: NotificationApi.delete_notification_by_slug_tracking_number ...'
-      end
-
-      if slug.nil? || (slug.to_s == '')
-        raise InvalidParamError.new "slug cannot be nil or empty"
-      end
-      if tracking_number.nil? || (tracking_number.to_s == '')
-        raise InvalidParamError.new "tracking_number cannot be nil or empty"
-      end
-
-
-      # resource path
-      local_var_path = "/tracking/2024-04/notifications/#{slug}/#{tracking_number}/remove" 
-      method = :'POST'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'tracking_account_number'] = opts[:'tracking_account_number'] if !opts[:'tracking_account_number'].nil?
-      query_params[:'tracking_origin_country'] = opts[:'tracking_origin_country'] if !opts[:'tracking_origin_country'].nil?
-      query_params[:'tracking_destination_country'] = opts[:'tracking_destination_country'] if !opts[:'tracking_destination_country'].nil?
-      query_params[:'tracking_key'] = opts[:'tracking_key'] if !opts[:'tracking_key'].nil?
-      query_params[:'tracking_postal_code'] = opts[:'tracking_postal_code'] if !opts[:'tracking_postal_code'].nil?
-      query_params[:'tracking_ship_date'] = opts[:'tracking_ship_date'] if !opts[:'tracking_ship_date'].nil?
-      query_params[:'tracking_state'] = opts[:'tracking_state'] if !opts[:'tracking_state'].nil?
-      # header parameters
-      header_params = opts[:header_params] || {}
-
-      # http body (model)
-      post_body = opts[:body]
-
-      # return_type
-      return_type = 'Notification'
-      
-      new_options = opts.merge(
-        :operation => :"NotificationApi.delete_notification_by_slug_tracking_number",
-        :header_params => header_params,
-        :query_params => query_params,
-        :body => post_body,
-        :return_type => return_type,
-        :response_legacy_tag => "notification",
-        :is_paging => false
-      )
-
-      data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: NotificationApi#delete_notification_by_slug_tracking_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end 
-
-    # delete_notification_by_tracking_id
-    # Remove notification receivers from a tracking number.
-    # @param tracking_id [String] tracking id
-
-    # @param body [Model::NotificationRequestV1] 
-    # @param [Hash] opts the optional parameters
-    # @return [Model::Notification] 
-    def delete_notification_by_tracking_id(tracking_id:, body:, opts: {})
-      if "notification" != ""
-        body = { :'notification' => body }
-      end
-      opts[:body] = body
-      data, _status_code, _headers = delete_notification_by_tracking_id_with_http_info(tracking_id: tracking_id, opts: opts)
-      data
-    end
-
-    def delete_notification_by_tracking_id_with_http_info(tracking_id:, opts: {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: NotificationApi.delete_notification_by_tracking_id ...'
-      end
-
-      if tracking_id.nil? || (tracking_id.to_s == '')
-        raise InvalidParamError.new "tracking_id cannot be nil or empty"
-      end
-
-
-      # resource path
-      local_var_path = "/tracking/2024-04/notifications/#{tracking_id}/remove" 
-      method = :'POST'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      # header parameters
-      header_params = opts[:header_params] || {}
-
-      # http body (model)
-      post_body = opts[:body]
-
-      # return_type
-      return_type = 'Notification'
-      
-      new_options = opts.merge(
-        :operation => :"NotificationApi.delete_notification_by_tracking_id",
-        :header_params => header_params,
-        :query_params => query_params,
-        :body => post_body,
-        :return_type => return_type,
-        :response_legacy_tag => "notification",
-        :is_paging => false
-      )
-
-      data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: NotificationApi#delete_notification_by_tracking_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end 
-
-    # get_notification_by_slug_tracking_number
-    # Get contact information for the users to notify when the tracking changes. Please note that only customer receivers will be returned. Any `email`, `sms` or `webhook` that belongs to the Store will not be returned.
-    # @param slug [String] Tracking slug
-    # @param tracking_number [String] Tracking number
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :tracking_account_number Additional field required by some carriers to retrieve the tracking info. The shipper’s carrier account number. Refer to our article on  for more details.
-    # @option opts [String] :tracking_origin_country Additional field required by some carriers to retrieve the tracking info. The origin country/region of the shipment. Refer to our article on  for more details.
-    # @option opts [String] :tracking_destination_country Additional field required by some carriers to retrieve the tracking info. The destination country/region of the shipment. Refer to our article on  for more details.
-    # @option opts [String] :tracking_key Additional field required by some carriers to retrieve the tracking info. A type of tracking credential required by some carriers. Refer to our article on  for more details.
-    # @option opts [String] :tracking_postal_code Additional field required by some carriers to retrieve the tracking info. The postal code of the recipient’s address. Refer to our article on  for more details.
-    # @option opts [String] :tracking_ship_date Additional field required by some carriers to retrieve the tracking info. The date the shipment was sent, using the format YYYYMMDD. Refer to our article on  for more details.
-    # @option opts [String] :tracking_state Additional field required by some carriers to retrieve the tracking info. The state/province of the recipient’s address. Refer to our article on  for more details.
-    # @return [Model::Notification] 
-    def get_notification_by_slug_tracking_number(slug:, tracking_number:, opts: {})
-      data, _status_code, _headers = get_notification_by_slug_tracking_number_with_http_info(slug: slug, tracking_number: tracking_number, opts: opts)
-      data
-    end
-
-    def get_notification_by_slug_tracking_number_with_http_info(slug:, tracking_number:, opts: {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: NotificationApi.get_notification_by_slug_tracking_number ...'
-      end
-
-      if slug.nil? || (slug.to_s == '')
-        raise InvalidParamError.new "slug cannot be nil or empty"
-      end
-      if tracking_number.nil? || (tracking_number.to_s == '')
-        raise InvalidParamError.new "tracking_number cannot be nil or empty"
-      end
-
-
-      # resource path
-      local_var_path = "/tracking/2024-04/notifications/#{slug}/#{tracking_number}" 
-      method = :'GET'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'tracking_account_number'] = opts[:'tracking_account_number'] if !opts[:'tracking_account_number'].nil?
-      query_params[:'tracking_origin_country'] = opts[:'tracking_origin_country'] if !opts[:'tracking_origin_country'].nil?
-      query_params[:'tracking_destination_country'] = opts[:'tracking_destination_country'] if !opts[:'tracking_destination_country'].nil?
-      query_params[:'tracking_key'] = opts[:'tracking_key'] if !opts[:'tracking_key'].nil?
-      query_params[:'tracking_postal_code'] = opts[:'tracking_postal_code'] if !opts[:'tracking_postal_code'].nil?
-      query_params[:'tracking_ship_date'] = opts[:'tracking_ship_date'] if !opts[:'tracking_ship_date'].nil?
-      query_params[:'tracking_state'] = opts[:'tracking_state'] if !opts[:'tracking_state'].nil?
-      # header parameters
-      header_params = opts[:header_params] || {}
-
-      # http body (model)
-      post_body = opts[:body]
-
-      # return_type
-      return_type = 'Notification'
-      
-      new_options = opts.merge(
-        :operation => :"NotificationApi.get_notification_by_slug_tracking_number",
-        :header_params => header_params,
-        :query_params => query_params,
-        :body => post_body,
-        :return_type => return_type,
-        :response_legacy_tag => "notification",
-        :is_paging => false
-      )
-
-      data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: NotificationApi#get_notification_by_slug_tracking_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end 
-
-    # get_notification_by_tracking_id
-    # Get contact information for the users to notify when the tracking changes. Please note that only customer receivers will be returned. Any `email`, `sms` or `webhook` that belongs to the Store will not be returned.
-    # @param tracking_id [String] tracking id
-    # @param [Hash] opts the optional parameters
-    # @return [Model::Notification] 
-    def get_notification_by_tracking_id(tracking_id:, opts: {})
-      data, _status_code, _headers = get_notification_by_tracking_id_with_http_info(tracking_id: tracking_id, opts: opts)
-      data
-    end
-
-    def get_notification_by_tracking_id_with_http_info(tracking_id:, opts: {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: NotificationApi.get_notification_by_tracking_id ...'
-      end
-
-      if tracking_id.nil? || (tracking_id.to_s == '')
-        raise InvalidParamError.new "tracking_id cannot be nil or empty"
-      end
-
-
-      # resource path
-      local_var_path = "/tracking/2024-04/notifications/#{tracking_id}" 
-      method = :'GET'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      # header parameters
-      header_params = opts[:header_params] || {}
-
-      # http body (model)
-      post_body = opts[:body]
-
-      # return_type
-      return_type = 'Notification'
-      
-      new_options = opts.merge(
-        :operation => :"NotificationApi.get_notification_by_tracking_id",
-        :header_params => header_params,
-        :query_params => query_params,
-        :body => post_body,
-        :return_type => return_type,
-        :response_legacy_tag => "notification",
-        :is_paging => false
-      )
-
-      data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: NotificationApi#get_notification_by_tracking_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end 
-  end
-end

data/lib/aftership-tracking-sdk/models/data_tracking_delete_response_v1.rb

@@ -1,151 +0,0 @@
-# This code was auto generated by AfterShip SDK Generator.
-# Do not edit the class manually.
-module AftershipAPI::Model
-  class DataTrackingDeleteResponseV1
-    # Partial tracking model
-    # tracking?: PartialDeleteTracking;
-    attr_accessor :tracking
-
-    # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::DataTrackingDeleteResponseV1` initialize method"
-      end
-
-      attributes = attributes.each_with_object({}) { |(k, v), h|
-        h[k.to_sym] = v
-      }
-
-      if attributes.key?(:'tracking')
-        self.tracking = attributes[:'tracking']
-      end 
-    end
-
-    # Attribute type mapping.
-    def self.openapi_types
-      {
-        :'tracking' => :'PartialDeleteTracking',
-      }
-    end
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'tracking' => :'tracking',
-      }
-    end
-
-    # Builds the object from hash
-    # @param attributes [Hash] Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def self.build_from_hash(attributes)
-      return nil unless attributes.is_a?(Hash)
-      attributes = attributes.transform_keys(&:to_sym)
-      transformed_hash = {}
-      openapi_types.each_pair do |key, type|
-        if attributes.key?(key) && attributes[key].nil?
-          transformed_hash["#{key}"] = nil
-        elsif type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the attribute
-          # is documented as an array but the input is not
-          if attributes[key].is_a?(Array)
-            transformed_hash["#{key}"] = attributes[key].map { |v| _deserialize($1, v) }
-          end
-        elsif !attributes[key].nil?
-          transformed_hash["#{key}"] = _deserialize(type, attributes[key])
-        end
-      end
-      new(transformed_hash)
-    end
-
-    # Deserializes the data based on type
-    # @param type [String] Data type
-    # @param value [String] Value to be deserialized
-    # @return [Object] Deserialized data
-    def self._deserialize(type, value)
-      case type.to_sym
-      when :Time
-        Time.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        klass = AftershipAPI::Model.const_get(type)
-        klass.build_from_hash(value)
-      end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
-    # Returns the object in the form of hash
-    # @return [Hash] Returns the object in the form of hash
-    def to_hash
-      hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
-        value = self.send(attr)
-        next if value.nil?
-
-        hash[param] = _to_hash(value)
-      end
-      hash
-    end
-
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param value [Object] Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
-
-    def to_json(*a)
-      to_hash.to_json(*a)
-    end
-  end
-end