pingram 1.0.11 → 1.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f2eb2a3bf5cc0ac15624218064f63c512eafb93d0695f2df84f8c95990ddf4e
-  data.tar.gz: 35ffdb54bb14e8ae2f5a4a4c0da537715de2b5d4b5600bf193f771ecda10278c
+  metadata.gz: cc0f817becd9705b1ebb50e8fcd710b93b8d3be965fff1a52d84f020679ad67e
+  data.tar.gz: 2a752eb8e38f74db65cdab431ca94994329777bfbafec3834a40aafdc8388336
 SHA512:
-  metadata.gz: d47b6b983521d1ae39b4168f0cf3aa129b264fe9845f0daa8a891a3e2deb20bd8e218a78f700756b6fc5a9a9dc31b73948067d684d3b7302520c577b6f3e77e1
-  data.tar.gz: 568d874bc0b12b9a07ddab8a759bb0f0aaa8d96ec24cc10eb71524d54bc679da5cde7aa2184d77b51cad2b36d6ba55a9a51c5aedd35646a437af9468658eaa1c
+  metadata.gz: 66ae5af2606968823cf5520930996b68c7eebf151ff988f863a7c524b0adea59787d077e270a1157f1e6efedcbe31e231b8eceffada53c8a17df9c44297d52a2
+  data.tar.gz: 9d0156592f907eb044f86002f987e3196e4bd89a161608cf765d9f66f316b42a39fa52bcee8d22b9ee176b0d4419986adbcfa9b0d4b297aeffd8234da1ae664e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pingram (1.0.11)
+    pingram (1.0.13)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/lib/pingram/api/numbers_api.rb

@@ -19,7 +19,7 @@ module Pingram
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # List all phone numbers registered for the account
+    # List active phone numbers registered for the account
     # @param [Hash] opts the optional parameters
     # @return [ListPhoneNumbersResponse]
     def numbers_list(opts = {})
@@ -27,7 +27,7 @@ module Pingram
       data
     end
 
-    # List all phone numbers registered for the account
+    # List active phone numbers registered for the account
     # @param [Hash] opts the optional parameters
     # @return [Array<(ListPhoneNumbersResponse, Integer, Hash)>] ListPhoneNumbersResponse data, response status code and response headers
     def numbers_list_with_http_info(opts = {})
@@ -74,7 +74,62 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Purchase a phone number for the authenticated account
+    # List released phone numbers. Released numbers may be purchased again with 2 weeks of being released. Released numbers may be removed from released list after 2 weeks.
+    # @param [Hash] opts the optional parameters
+    # @return [ListReleasedPhoneNumbersResponse]
+    def numbers_list_released(opts = {})
+      data, _status_code, _headers = numbers_list_released_with_http_info(opts)
+      data
+    end
+
+    # List released phone numbers. Released numbers may be purchased again with 2 weeks of being released. Released numbers may be removed from released list after 2 weeks.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ListReleasedPhoneNumbersResponse, Integer, Hash)>] ListReleasedPhoneNumbersResponse data, response status code and response headers
+    def numbers_list_released_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NumbersApi.numbers_list_released ...'
+      end
+      # resource path
+      local_var_path = '/numbers/released'
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListReleasedPhoneNumbersResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"NumbersApi.numbers_list_released",
+        :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: NumbersApi#numbers_list_released\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Purchase a phone number for the authenticated account, or reactivate a released number owned by the account (preserves original createdAt).
     # @param order_phone_number_request [OrderPhoneNumberRequest] 
     # @param [Hash] opts the optional parameters
     # @return [OrderPhoneNumberResponse]
@@ -83,7 +138,7 @@ module Pingram
       data
     end
 
-    # Purchase a phone number for the authenticated account
+    # Purchase a phone number for the authenticated account, or reactivate a released number owned by the account (preserves original createdAt).
     # @param order_phone_number_request [OrderPhoneNumberRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(OrderPhoneNumberResponse, Integer, Hash)>] OrderPhoneNumberResponse data, response status code and response headers
@@ -140,6 +195,67 @@ module Pingram
       return data, status_code, headers
     end
 
+    # Release a phone number from the account. No refund for the current billing month.
+    # @param phone_number [String] E.164 phone number to release
+    # @param [Hash] opts the optional parameters
+    # @return [ReleasePhoneNumberResponse]
+    def numbers_release_number(phone_number, opts = {})
+      data, _status_code, _headers = numbers_release_number_with_http_info(phone_number, opts)
+      data
+    end
+
+    # Release a phone number from the account. No refund for the current billing month.
+    # @param phone_number [String] E.164 phone number to release
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ReleasePhoneNumberResponse, Integer, Hash)>] ReleasePhoneNumberResponse data, response status code and response headers
+    def numbers_release_number_with_http_info(phone_number, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NumbersApi.numbers_release_number ...'
+      end
+      # verify the required parameter 'phone_number' is set
+      if @api_client.config.client_side_validation && phone_number.nil?
+        fail ArgumentError, "Missing the required parameter 'phone_number' when calling NumbersApi.numbers_release_number"
+      end
+      # resource path
+      local_var_path = '/numbers/{phoneNumber}'.sub('{' + 'phoneNumber' + '}', CGI.escape(phone_number.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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ReleasePhoneNumberResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"NumbersApi.numbers_release_number",
+        :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: NumbersApi#numbers_release_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Search for available phone numbers
     # @param country_code [String] ISO 3166-1 alpha-2 country code (e.g., US, CA)
     # @param [Hash] opts the optional parameters

data/lib/pingram/api/organization_api.rb

@@ -19,6 +19,61 @@ module Pingram
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Create organization after SMS verification bypass
+    # @param [Hash] opts the optional parameters
+    # @return [CreateOrganizationResponse]
+    def organization_create(opts = {})
+      data, _status_code, _headers = organization_create_with_http_info(opts)
+      data
+    end
+
+    # Create organization after SMS verification bypass
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateOrganizationResponse, Integer, Hash)>] CreateOrganizationResponse data, response status code and response headers
+    def organization_create_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrganizationApi.organization_create ...'
+      end
+      # resource path
+      local_var_path = '/organizations'
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateOrganizationResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrganizationApi.organization_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: OrganizationApi#organization_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get usage for the authenticated account's organization (new billing model).
     # @param [Hash] opts the optional parameters
     # @return [OrganizationUsage]

data/lib/pingram/api_client.rb

@@ -32,7 +32,7 @@ module Pingram
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "pingram-ruby/1.0.11"
+      @user_agent = "pingram-ruby/1.0.13"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/pingram/models/a2p_registration.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Pingram
-  # Public response type for A2P registration - excludes internal Telnyx IDs
+  # Public response type for A2P registration
   class A2pRegistration < ApiModelBase
     attr_accessor :account_id
 

data/lib/pingram/models/create_organization_response.rb

@@ -0,0 +1,216 @@
+=begin
+#Pingram
+
+#Internal API for notification delivery and management
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Pingram
+  class CreateOrganizationResponse < ApiModelBase
+    attr_accessor :success
+
+    attr_accessor :account_id
+
+    attr_accessor :organization_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'success' => :'success',
+        :'account_id' => :'accountId',
+        :'organization_id' => :'organizationId'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'success' => :'Boolean',
+        :'account_id' => :'String',
+        :'organization_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # 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 `Pingram::CreateOrganizationResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Pingram::CreateOrganizationResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
+      else
+        self.success = nil
+      end
+
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      else
+        self.account_id = nil
+      end
+
+      if attributes.key?(:'organization_id')
+        self.organization_id = attributes[:'organization_id']
+      else
+        self.organization_id = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @success.nil?
+        invalid_properties.push('invalid value for "success", success cannot be nil.')
+      end
+
+      if @account_id.nil?
+        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
+      end
+
+      if @organization_id.nil?
+        invalid_properties.push('invalid value for "organization_id", organization_id cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @success.nil?
+      return false if @account_id.nil?
+      return false if @organization_id.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] success Value to be assigned
+    def success=(success)
+      if success.nil?
+        fail ArgumentError, 'success cannot be nil'
+      end
+
+      @success = success
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] account_id Value to be assigned
+    def account_id=(account_id)
+      if account_id.nil?
+        fail ArgumentError, 'account_id cannot be nil'
+      end
+
+      @account_id = account_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] organization_id Value to be assigned
+    def organization_id=(organization_id)
+      if organization_id.nil?
+        fail ArgumentError, 'organization_id cannot be nil'
+      end
+
+      @organization_id = organization_id
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          success == o.success &&
+          account_id == o.account_id &&
+          organization_id == o.organization_id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [success, account_id, organization_id].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes 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?(attribute_map[key]) && attributes[attribute_map[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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/pingram/models/list_phone_numbers_response.rb

@@ -14,7 +14,6 @@ require 'date'
 require 'time'
 
 module Pingram
-  # Response for GET /numbers/list
   class ListPhoneNumbersResponse < ApiModelBase
     attr_accessor :numbers