pingram 1.0.25 → 1.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a40e934d6c76c61dfd991994caec21cc77a45770b6a455e9bc3d965ade02506c
-  data.tar.gz: 378e5208e84f02153580d9fc28b0e292462e29939bf177ee13c458205010a5d5
+  metadata.gz: 0f540ef8b53152ed4f6ecd3308f797e0374b539c96bfd6c23f437f4c939ca8d9
+  data.tar.gz: ef7b88a8438baee017236e05065a974321658e45dc07efe52665a3bdbfa97d5e
 SHA512:
-  metadata.gz: fb6b0d51d15a26a466b00db189a14edc559994e1bb398f1df861f9c5d38995240237bb8cefd6bcc3758f73953f71ed62f70134c0087bfdd7789c7bb6d46915c2
-  data.tar.gz: 969b719b60bf55ff43cebde3a696ad2a93e40b799b276f0fb0f67da99cea62322ad1937286301e29d1112bf5186a745f608c5cc3a59868c0ca0b22d88d3ce879
+  metadata.gz: 5da3ff704b8ed13a71b3a3d1a0c1a690006e46ff495c4661649e5a8f2cca1c96e596f14587f3020e53e0c98174270fd6b7b5b6134403ebe0e92402a640f69730
+  data.tar.gz: 8c5b60183fc0c0cf58f4b3895a7ebb0665e70ffb4d000a3b694c0a3085cbd537e623727ddd4033e58774b15b921db3b5862084821ca195856890b2ab7bf54b1f

data/Gemfile.lock

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

data/lib/pingram/api/environments_api.rb

@@ -19,72 +19,6 @@ module Pingram
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Create a new environment for the account
-    # @param environment_create_request [EnvironmentCreateRequest] 
-    # @param [Hash] opts the optional parameters
-    # @return [Environment]
-    def environments_create_environment(environment_create_request, opts = {})
-      data, _status_code, _headers = environments_create_environment_with_http_info(environment_create_request, opts)
-      data
-    end
-
-    # Create a new environment for the account
-    # @param environment_create_request [EnvironmentCreateRequest] 
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Environment, Integer, Hash)>] Environment data, response status code and response headers
-    def environments_create_environment_with_http_info(environment_create_request, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: EnvironmentsApi.environments_create_environment ...'
-      end
-      # verify the required parameter 'environment_create_request' is set
-      if @api_client.config.client_side_validation && environment_create_request.nil?
-        fail ArgumentError, "Missing the required parameter 'environment_create_request' when calling EnvironmentsApi.environments_create_environment"
-      end
-      # resource path
-      local_var_path = '/environments'
-
-      # 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(environment_create_request)
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'Environment'
-
-      # 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 => :"EnvironmentsApi.environments_create_environment",
-        :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: EnvironmentsApi#environments_create_environment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Get all environments for the authenticated account
     # @param [Hash] opts the optional parameters
     # @return [Array<GetEnvironmentsResponseInner>]

data/lib/pingram/api/registrations_api.rb

@@ -140,6 +140,61 @@ module Pingram
       return data, status_code, headers
     end
 
+    # Get the 10DLC campaign registration for the authenticated account. Returns null when no brand registration exists yet.
+    # @param [Hash] opts the optional parameters
+    # @return [TenDlcCampaignRegistration]
+    def registrations_get_us10dlc_campaign(opts = {})
+      data, _status_code, _headers = registrations_get_us10dlc_campaign_with_http_info(opts)
+      data
+    end
+
+    # Get the 10DLC campaign registration for the authenticated account. Returns null when no brand registration exists yet.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TenDlcCampaignRegistration, Integer, Hash)>] TenDlcCampaignRegistration data, response status code and response headers
+    def registrations_get_us10dlc_campaign_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RegistrationsApi.registrations_get_us10dlc_campaign ...'
+      end
+      # resource path
+      local_var_path = '/registrations/us/10dlc/campaign'
+
+      # 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] || 'TenDlcCampaignRegistration'
+
+      # 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 => :"RegistrationsApi.registrations_get_us10dlc_campaign",
+        :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: RegistrationsApi#registrations_get_us10dlc_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update an existing 10DLC brand registration. Business fields are editable before carrier submission; workflow status is managed by Pingram.
     # @param ten_dlc_brand_update_request [TenDlcBrandUpdateRequest] 
     # @param [Hash] opts the optional parameters
@@ -205,5 +260,71 @@ module Pingram
       end
       return data, status_code, headers
     end
+
+    # Update an existing 10DLC campaign registration. Campaign fields are editable before carrier submission; workflow status is managed by Pingram.
+    # @param ten_dlc_campaign_update_request [TenDlcCampaignUpdateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [TenDlcCampaignRegistration]
+    def registrations_update_us10dlc_campaign(ten_dlc_campaign_update_request, opts = {})
+      data, _status_code, _headers = registrations_update_us10dlc_campaign_with_http_info(ten_dlc_campaign_update_request, opts)
+      data
+    end
+
+    # Update an existing 10DLC campaign registration. Campaign fields are editable before carrier submission; workflow status is managed by Pingram.
+    # @param ten_dlc_campaign_update_request [TenDlcCampaignUpdateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TenDlcCampaignRegistration, Integer, Hash)>] TenDlcCampaignRegistration data, response status code and response headers
+    def registrations_update_us10dlc_campaign_with_http_info(ten_dlc_campaign_update_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RegistrationsApi.registrations_update_us10dlc_campaign ...'
+      end
+      # verify the required parameter 'ten_dlc_campaign_update_request' is set
+      if @api_client.config.client_side_validation && ten_dlc_campaign_update_request.nil?
+        fail ArgumentError, "Missing the required parameter 'ten_dlc_campaign_update_request' when calling RegistrationsApi.registrations_update_us10dlc_campaign"
+      end
+      # resource path
+      local_var_path = '/registrations/us/10dlc/campaign'
+
+      # 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(ten_dlc_campaign_update_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'TenDlcCampaignRegistration'
+
+      # 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 => :"RegistrationsApi.registrations_update_us10dlc_campaign",
+        :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(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RegistrationsApi#registrations_update_us10dlc_campaign\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.25"
+      @user_agent = "pingram-ruby/1.0.28"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/pingram/models/create_account_response.rb

@@ -24,6 +24,9 @@ module Pingram
 
     attr_accessor :subscription_status
 
+    # Default secret API key for the new account (`pingram_sk_…`).
+    attr_accessor :api_key
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -52,7 +55,8 @@ module Pingram
         :'account_id' => :'accountId',
         :'name' => :'name',
         :'status' => :'status',
-        :'subscription_status' => :'subscriptionStatus'
+        :'subscription_status' => :'subscriptionStatus',
+        :'api_key' => :'apiKey'
       }
     end
 
@@ -72,14 +76,15 @@ module Pingram
         :'account_id' => :'String',
         :'name' => :'String',
         :'status' => :'String',
-        :'subscription_status' => :'String'
+        :'subscription_status' => :'String',
+        :'api_key' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'subscription_status'
+        :'subscription_status',
       ])
     end
 
@@ -120,6 +125,12 @@ module Pingram
       if attributes.key?(:'subscription_status')
         self.subscription_status = attributes[:'subscription_status']
       end
+
+      if attributes.key?(:'api_key')
+        self.api_key = attributes[:'api_key']
+      else
+        self.api_key = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -139,6 +150,10 @@ module Pingram
         invalid_properties.push('invalid value for "status", status cannot be nil.')
       end
 
+      if @api_key.nil?
+        invalid_properties.push('invalid value for "api_key", api_key cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -153,6 +168,7 @@ module Pingram
       return false unless status_validator.valid?(@status)
       subscription_status_validator = EnumAttributeValidator.new('String', ["active", "canceled", "past_due", "paused"])
       return false unless subscription_status_validator.valid?(@subscription_status)
+      return false if @api_key.nil?
       true
     end
 
@@ -196,6 +212,16 @@ module Pingram
       @subscription_status = subscription_status
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] api_key Value to be assigned
+    def api_key=(api_key)
+      if api_key.nil?
+        fail ArgumentError, 'api_key cannot be nil'
+      end
+
+      @api_key = api_key
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -204,7 +230,8 @@ module Pingram
           account_id == o.account_id &&
           name == o.name &&
           status == o.status &&
-          subscription_status == o.subscription_status
+          subscription_status == o.subscription_status &&
+          api_key == o.api_key
     end
 
     # @see the `==` method
@@ -216,7 +243,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, name, status, subscription_status].hash
+      [account_id, name, status, subscription_status, api_key].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/ten_dlc_brand_admin_update_request.rb

@@ -56,7 +56,7 @@ module Pingram
     # Legacy only when businessType is Other.
     attr_accessor :entity_type
 
-    # Pingram-side brand registration workflow status. - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome
+    # Pingram-side 10DLC registration workflow status (brand or campaign). - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome
     attr_accessor :brand_status
 
     class EnumAttributeValidator

data/lib/pingram/models/ten_dlc_brand_registration.rb

@@ -52,10 +52,10 @@ module Pingram
 
     attr_accessor :compliance_contact_phone
 
-    # Pingram-side brand registration workflow status. - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome
+    # Pingram-side 10DLC registration workflow status (brand or campaign). - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome
     attr_accessor :brand_status
 
-    # Pingram-side brand registration workflow status. - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome
+    # Pingram-side 10DLC registration workflow status (brand or campaign). - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome
     attr_accessor :campaign_status
 
     attr_accessor :created_at

data/lib/pingram/models/ten_dlc_brand_registration_details.rb

@@ -52,10 +52,10 @@ module Pingram
 
     attr_accessor :compliance_contact_phone
 
-    # Pingram-side brand registration workflow status. - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome
+    # Pingram-side 10DLC registration workflow status (brand or campaign). - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome
     attr_accessor :brand_status
 
-    # Pingram-side brand registration workflow status. - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome
+    # Pingram-side 10DLC registration workflow status (brand or campaign). - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome
     attr_accessor :campaign_status
 
     attr_accessor :created_at