pingram 1.0.3 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc6660f67916fa675695a13305efe810001d1df21c9e285337469d43a3dde6ec
-  data.tar.gz: d524333c31763799b4d4c616631e8e17e7302015e067af9e58b4a72131f61722
+  metadata.gz: 6e4c8f5eaa4554d081edda85a3a512cd529bf433cc58c6f8d08282a51914f5d4
+  data.tar.gz: 4318d13e710336127a0b13d0a47296e4ff1f889ef2b9f2c7c26b2098f869b651
 SHA512:
-  metadata.gz: dce1a3f9e59d7157beec155a7e4ec1a96620caec8b6b9d7d14cc32892ba1f5c01c0a405bd5c3870c16d4a26f50d30bb2f51946f7b3b4dc4e82389c9a27554a29
-  data.tar.gz: b4498c54781244db68765030f4865c77a9b3ce840e33cd4d9f492d740b41ccc4b6d2373a2fe898ef25885e6e12393b56de949449aaf2a873680b5d3a754611c1
+  metadata.gz: ef0521c2d19294c45dbc0adf73ad71a1c71229ade16a2f9a49cc9cf3f4ed0311ab275f563b21fba7a63fef8750a5a8f9d2b0a9ccc02b4fbe4be99060c8b38265
+  data.tar.gz: f0e4eff10e4173c072bfd217d4c3f50b8bee7fe96fd2fbdcec1064f49a1aa4256d9e3552e21358b074244e1f69862439e5c55dec1d3274c12fcab7cb441f6227

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pingram (1.0.3)
+    pingram (1.0.6)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -13,14 +13,16 @@ GEM
     coderay (1.1.3)
     date (3.5.1)
     diff-lcs (1.6.2)
-    ethon (0.15.0)
+    ethon (0.18.0)
       ffi (>= 1.15.0)
-    ffi (1.17.3-x86_64-linux-gnu)
+      logger
+    ffi (1.17.4-x86_64-linux-gnu)
     io-console (0.8.2)
     jaro_winkler (1.5.6)
+    logger (1.7.0)
     method_source (1.1.0)
-    parallel (1.27.0)
-    parser (3.3.10.2)
+    parallel (1.28.0)
+    parser (3.3.11.1)
       ast (~> 2.4.1)
       racc
     pry (0.16.0)
@@ -61,8 +63,8 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.13.0)
     stringio (3.2.0)
-    typhoeus (1.5.0)
-      ethon (>= 0.9.0, < 0.16.0)
+    typhoeus (1.6.0)
+      ethon (>= 0.18.0)
     unicode-display_width (1.5.0)
 
 PLATFORMS

data/lib/pingram/api/members_api.rb

@@ -19,7 +19,7 @@ module Pingram
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Get auto-join domains for the account
+    # Get auto-join domains for the organization
     # @param env_id [String] Environment ID
     # @param [Hash] opts the optional parameters
     # @return [AutoJoinGetResponse]
@@ -28,7 +28,7 @@ module Pingram
       data
     end
 
-    # Get auto-join domains for the account
+    # Get auto-join domains for the organization
     # @param env_id [String] Environment ID
     # @param [Hash] opts the optional parameters
     # @return [Array<(AutoJoinGetResponse, Integer, Hash)>] AutoJoinGetResponse data, response status code and response headers
@@ -80,7 +80,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Invite a new member to the account
+    # Invite a new member to the organization
     # @param env_id [String] Environment ID
     # @param member_invite_request [MemberInviteRequest] 
     # @param [Hash] opts the optional parameters
@@ -90,7 +90,7 @@ module Pingram
       data
     end
 
-    # Invite a new member to the account
+    # Invite a new member to the organization
     # @param env_id [String] Environment ID
     # @param member_invite_request [MemberInviteRequest] 
     # @param [Hash] opts the optional parameters
@@ -152,7 +152,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Get a list of team members in the account
+    # Get a list of team members in the organization
     # @param env_id [String] Environment ID
     # @param [Hash] opts the optional parameters
     # @return [Array<GetMembersResponseInner>]
@@ -161,7 +161,7 @@ module Pingram
       data
     end
 
-    # Get a list of team members in the account
+    # Get a list of team members in the organization
     # @param env_id [String] Environment ID
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<GetMembersResponseInner>, Integer, Hash)>] Array<GetMembersResponseInner> data, response status code and response headers
@@ -213,7 +213,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Remove a member from the account
+    # Remove a member from the organization
     # @param env_id [String] Environment ID
     # @param user_id [String] User ID or email address (URL encoded)
     # @param [Hash] opts the optional parameters
@@ -223,7 +223,7 @@ module Pingram
       data
     end
 
-    # Remove a member from the account
+    # Remove a member from the organization
     # @param env_id [String] Environment ID
     # @param user_id [String] User ID or email address (URL encoded)
     # @param [Hash] opts the optional parameters
@@ -280,7 +280,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Set auto-join domains for the account
+    # Set auto-join domains for the organization
     # @param env_id [String] Environment ID
     # @param auto_join_request_body [AutoJoinRequestBody] 
     # @param [Hash] opts the optional parameters
@@ -290,7 +290,7 @@ module Pingram
       data
     end
 
-    # Set auto-join domains for the account
+    # Set auto-join domains for the organization
     # @param env_id [String] Environment ID
     # @param auto_join_request_body [AutoJoinRequestBody] 
     # @param [Hash] opts the optional parameters

data/lib/pingram/api/numbers_api.rb

@@ -0,0 +1,214 @@
+=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 'cgi'
+
+module Pingram
+  class NumbersApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List all phone numbers registered for the account
+    # @param [Hash] opts the optional parameters
+    # @return [ListPhoneNumbersResponse]
+    def numbers_list(opts = {})
+      data, _status_code, _headers = numbers_list_with_http_info(opts)
+      data
+    end
+
+    # List all 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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NumbersApi.numbers_list ...'
+      end
+      # resource path
+      local_var_path = '/numbers/list'
+
+      # 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] || 'ListPhoneNumbersResponse'
+
+      # 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",
+        :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\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Purchase a Telnyx phone number for the authenticated account
+    # @param order_phone_number_request [OrderPhoneNumberRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [OrderPhoneNumberResponse]
+    def numbers_order_number(order_phone_number_request, opts = {})
+      data, _status_code, _headers = numbers_order_number_with_http_info(order_phone_number_request, opts)
+      data
+    end
+
+    # Purchase a Telnyx phone number for the authenticated account
+    # @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
+    def numbers_order_number_with_http_info(order_phone_number_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NumbersApi.numbers_order_number ...'
+      end
+      # verify the required parameter 'order_phone_number_request' is set
+      if @api_client.config.client_side_validation && order_phone_number_request.nil?
+        fail ArgumentError, "Missing the required parameter 'order_phone_number_request' when calling NumbersApi.numbers_order_number"
+      end
+      # resource path
+      local_var_path = '/numbers/order'
+
+      # 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']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      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(order_phone_number_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OrderPhoneNumberResponse'
+
+      # 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_order_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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: NumbersApi#numbers_order_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Search for available Telnyx phone numbers
+    # @param country_code [String] ISO 3166-1 alpha-2 country code (e.g., US, CA)
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :features Comma-separated
+    # @option opts [String] :area_code National destination / area code filter
+    # @option opts [Float] :limit Max results (default 10, max 50)
+    # @return [SearchAvailablePhoneNumbersResponse]
+    def numbers_search_available(country_code, opts = {})
+      data, _status_code, _headers = numbers_search_available_with_http_info(country_code, opts)
+      data
+    end
+
+    # Search for available Telnyx phone numbers
+    # @param country_code [String] ISO 3166-1 alpha-2 country code (e.g., US, CA)
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :features Comma-separated
+    # @option opts [String] :area_code National destination / area code filter
+    # @option opts [Float] :limit Max results (default 10, max 50)
+    # @return [Array<(SearchAvailablePhoneNumbersResponse, Integer, Hash)>] SearchAvailablePhoneNumbersResponse data, response status code and response headers
+    def numbers_search_available_with_http_info(country_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NumbersApi.numbers_search_available ...'
+      end
+      # verify the required parameter 'country_code' is set
+      if @api_client.config.client_side_validation && country_code.nil?
+        fail ArgumentError, "Missing the required parameter 'country_code' when calling NumbersApi.numbers_search_available"
+      end
+      # resource path
+      local_var_path = '/numbers/available'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'countryCode'] = country_code
+      query_params[:'features'] = opts[:'features'] if !opts[:'features'].nil?
+      query_params[:'areaCode'] = opts[:'area_code'] if !opts[:'area_code'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+
+      # 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] || 'SearchAvailablePhoneNumbersResponse'
+
+      # 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_search_available",
+        :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_search_available\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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.3"
+      @user_agent = "pingram-ruby/1.0.6"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/pingram/client_wrapper.rb

@@ -31,6 +31,8 @@ require_relative 'api/logs_api'
 
 require_relative 'api/members_api'
 
+require_relative 'api/numbers_api'
+
 require_relative 'api/organization_api'
 
 require_relative 'api/push_settings_api'
@@ -91,6 +93,8 @@ module Pingram
 
       @members = Pingram::MembersApi.new(@api_client)
 
+      @numbers = Pingram::NumbersApi.new(@api_client)
+
       @organization = Pingram::OrganizationApi.new(@api_client)
 
       @push_settings = Pingram::PushsettingsApi.new(@api_client)
@@ -182,6 +186,12 @@ module Pingram
     end
 
 
+    # @return [Pingram::NumbersApi]
+    def numbers
+      @numbers
+    end
+
+
     # @return [Pingram::OrganizationApi]
     def organization
       @organization

data/lib/pingram/models/account_get_response.rb

@@ -14,48 +14,22 @@ require 'date'
 require 'time'
 
 module Pingram
-  # GET /account response: basic account info (billing fields are on Organization).
+  # GET /account response: basic account info (billing fields are on the organization).
   class AccountGetResponse < ApiModelBase
     attr_accessor :account_id
 
-    # Optional organization ID; legacy accounts may not have one.
     attr_accessor :organization_id
 
     attr_accessor :name
 
-    attr_accessor :account_type
-
     attr_accessor :created_at
 
-    class EnumAttributeValidator
-      attr_reader :datatype
-      attr_reader :allowable_values
-
-      def initialize(datatype, allowable_values)
-        @allowable_values = allowable_values.map do |value|
-          case datatype.to_s
-          when /Integer/i
-            value.to_i
-          when /Float/i
-            value.to_f
-          else
-            value
-          end
-        end
-      end
-
-      def valid?(value)
-        !value || allowable_values.include?(value)
-      end
-    end
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'account_id' => :'accountId',
         :'organization_id' => :'organizationId',
         :'name' => :'name',
-        :'account_type' => :'accountType',
         :'created_at' => :'createdAt'
       }
     end
@@ -76,7 +50,6 @@ module Pingram
         :'account_id' => :'String',
         :'organization_id' => :'String',
         :'name' => :'String',
-        :'account_type' => :'String',
         :'created_at' => :'String'
       }
     end
@@ -111,6 +84,8 @@ module Pingram
 
       if attributes.key?(:'organization_id')
         self.organization_id = attributes[:'organization_id']
+      else
+        self.organization_id = nil
       end
 
       if attributes.key?(:'name')
@@ -119,12 +94,6 @@ module Pingram
         self.name = nil
       end
 
-      if attributes.key?(:'account_type')
-        self.account_type = attributes[:'account_type']
-      else
-        self.account_type = nil
-      end
-
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       else
@@ -141,12 +110,12 @@ module Pingram
         invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
       end
 
-      if @name.nil?
-        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      if @organization_id.nil?
+        invalid_properties.push('invalid value for "organization_id", organization_id cannot be nil.')
       end
 
-      if @account_type.nil?
-        invalid_properties.push('invalid value for "account_type", account_type cannot be nil.')
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
       end
 
       if @created_at.nil?
@@ -161,10 +130,8 @@ module Pingram
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @account_id.nil?
+      return false if @organization_id.nil?
       return false if @name.nil?
-      return false if @account_type.nil?
-      account_type_validator = EnumAttributeValidator.new('String', ["free", "paid"])
-      return false unless account_type_validator.valid?(@account_type)
       return false if @created_at.nil?
       true
     end
@@ -179,6 +146,16 @@ module Pingram
       @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
+
     # Custom attribute writer method with validation
     # @param [Object] name Value to be assigned
     def name=(name)
@@ -189,16 +166,6 @@ module Pingram
       @name = name
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] account_type Object to be assigned
-    def account_type=(account_type)
-      validator = EnumAttributeValidator.new('String', ["free", "paid"])
-      unless validator.valid?(account_type)
-        fail ArgumentError, "invalid value for \"account_type\", must be one of #{validator.allowable_values}."
-      end
-      @account_type = account_type
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] created_at Value to be assigned
     def created_at=(created_at)
@@ -217,7 +184,6 @@ module Pingram
           account_id == o.account_id &&
           organization_id == o.organization_id &&
           name == o.name &&
-          account_type == o.account_type &&
           created_at == o.created_at
     end
 
@@ -230,7 +196,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, organization_id, name, account_type, created_at].hash
+      [account_id, organization_id, name, created_at].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/auto_join_get_response.rb

@@ -15,14 +15,14 @@ require 'time'
 
 module Pingram
   class AutoJoinGetResponse < ApiModelBase
-    attr_accessor :account_id
+    attr_accessor :organization_id
 
     attr_accessor :domains
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'account_id' => :'accountId',
+        :'organization_id' => :'organizationId',
         :'domains' => :'domains'
       }
     end
@@ -40,7 +40,7 @@ module Pingram
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'account_id' => :'String',
+        :'organization_id' => :'String',
         :'domains' => :'Array<String>'
       }
     end
@@ -67,10 +67,10 @@ module Pingram
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'account_id')
-        self.account_id = attributes[:'account_id']
+      if attributes.key?(:'organization_id')
+        self.organization_id = attributes[:'organization_id']
       else
-        self.account_id = nil
+        self.organization_id = nil
       end
 
       if attributes.key?(:'domains')
@@ -87,8 +87,8 @@ module Pingram
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @account_id.nil?
-        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
+      if @organization_id.nil?
+        invalid_properties.push('invalid value for "organization_id", organization_id cannot be nil.')
       end
 
       if @domains.nil?
@@ -102,19 +102,19 @@ module Pingram
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @account_id.nil?
+      return false if @organization_id.nil?
       return false if @domains.nil?
       true
     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'
+    # @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
 
-      @account_id = account_id
+      @organization_id = organization_id
     end
 
     # Custom attribute writer method with validation
@@ -132,7 +132,7 @@ module Pingram
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          account_id == o.account_id &&
+          organization_id == o.organization_id &&
           domains == o.domains
     end
 
@@ -145,7 +145,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, domains].hash
+      [organization_id, domains].hash
     end
 
     # Builds the object from hash