ngrok-api 0.26.0 → 0.27.0

data/lib/ngrokapi/services/reserved_domains_client.rb

@@ -149,6 +149,7 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -156,11 +157,13 @@ module NgrokAPI
       def list(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           url: url,
           path: PATH
         )
@@ -179,6 +182,7 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -186,11 +190,13 @@ module NgrokAPI
       def list!(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           danger: true,
           url: url,
           path: PATH

data/lib/ngrokapi/services/secrets_client.rb

@@ -29,10 +29,11 @@ module NgrokAPI
       # @param [string] metadata Arbitrary user-defined metadata for this Secret
       # @param [string] description description of Secret
       # @param [string] vault_id unique identifier of the referenced vault
+      # @param [string] vault_name name of the referenced vault
       # @return [NgrokAPI::Models::Secret] result from the API request
       #
       # https://ngrok.com/docs/api#api-secrets-create
-      def create(name: "", value: "", metadata: "", description: "", vault_id:)
+      def create(name: "", value: "", metadata: "", description: "", vault_id: "", vault_name: "")
         path = '/vault_secrets'
         replacements = {
         }
@@ -42,6 +43,7 @@ module NgrokAPI
         data[:metadata] = metadata if metadata
         data[:description] = description if description
         data[:vault_id] = vault_id if vault_id
+        data[:vault_name] = vault_name if vault_name
         result = @client.post(path % replacements, data: data)
         NgrokAPI::Models::Secret.new(client: self, attrs: result)
       end
@@ -55,10 +57,11 @@ module NgrokAPI
       # @param [string] metadata Arbitrary user-defined metadata for this Secret
       # @param [string] description description of Secret
       # @param [string] vault_id unique identifier of the referenced vault
+      # @param [string] vault_name name of the referenced vault
       # @return [NgrokAPI::Models::Secret] result from the API request
       #
       # https://ngrok.com/docs/api#api-secrets-create
-      def create!(name: "", value: "", metadata: "", description: "", vault_id:)
+      def create!(name: "", value: "", metadata: "", description: "", vault_id: "", vault_name: "")
         path = '/vault_secrets'
         replacements = {
         }
@@ -68,6 +71,7 @@ module NgrokAPI
         data[:metadata] = metadata if metadata
         data[:description] = description if description
         data[:vault_id] = vault_id if vault_id
+        data[:vault_name] = vault_name if vault_name
         result = @client.post(path % replacements, data: data, danger: true)
         NgrokAPI::Models::Secret.new(client: self, attrs: result)
       end
@@ -194,6 +198,7 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -201,11 +206,13 @@ module NgrokAPI
       def list(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           url: url,
           path: PATH
         )
@@ -224,6 +231,7 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -231,11 +239,13 @@ module NgrokAPI
       def list!(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           danger: true,
           url: url,
           path: PATH

data/lib/ngrokapi/services/service_users_client.rb

@@ -0,0 +1,237 @@
+# frozen_string_literal: true
+
+# Code generated for API Clients. DO NOT EDIT.
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-service-users
+    class ServiceUsersClient
+      # The API path for the requests
+      PATH = '/service_users'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'service_users'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Create a new service user
+      #
+      # @param [string] name human-readable name used to identify the service
+      # @param [boolean] active whether or not the service is active
+      # @return [NgrokAPI::Models::ServiceUser] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-service-users-create
+      def create(name: "", active: nil)
+        path = '/service_users'
+        replacements = {
+        }
+        data = {}
+        data[:name] = name if name
+        data[:active] = active if active
+        result = @client.post(path % replacements, data: data)
+        NgrokAPI::Models::ServiceUser.new(client: self, attrs: result)
+      end
+
+      ##
+      # Create a new service user
+      # Throws an exception if API error.
+      #
+      # @param [string] name human-readable name used to identify the service
+      # @param [boolean] active whether or not the service is active
+      # @return [NgrokAPI::Models::ServiceUser] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-service-users-create
+      def create!(name: "", active: nil)
+        path = '/service_users'
+        replacements = {
+        }
+        data = {}
+        data[:name] = name if name
+        data[:active] = active if active
+        result = @client.post(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::ServiceUser.new(client: self, attrs: result)
+      end
+
+      ##
+      # Delete a service user by ID
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-service-users-delete
+      def delete(id: "")
+        path = '/service_users/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete a service user by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-service-users-delete
+      def delete!(id: "")
+        path = '/service_users/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+
+      ##
+      # Get the details of a Bot User by ID.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::ServiceUser] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-service-users-get
+      def get(id: "")
+        path = '/service_users/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::ServiceUser.new(client: self, attrs: result)
+      end
+
+      ##
+      # Get the details of a Bot User by ID.
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::ServiceUser] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-service-users-get
+      def get!(id: "")
+        path = '/service_users/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::ServiceUser.new(client: self, attrs: result)
+      end
+
+      ##
+      # List all service users in this account.
+      #
+      # @param [string] before_id
+      # @param [string] limit
+      # @param [string] filter
+      # @param [string] url optional and mutually exclusive from before_id and limit
+      # @return [NgrokAPI::Models::Listable] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-service-users-list
+      def list(
+        before_id: nil,
+        limit: nil,
+        filter: nil,
+        url: nil
+      )
+        result = @client.list(
+          before_id: before_id,
+          limit: limit,
+          filter: filter,
+          url: url,
+          path: PATH
+        )
+
+        NgrokAPI::Models::Listable.new(
+          client: self,
+          attrs: result,
+          list_property: LIST_PROPERTY,
+          klass: NgrokAPI::Models::ServiceUser
+        )
+      end
+
+      ##
+      # List all service users in this account.
+      # Throws an exception if API error.
+      #
+      # @param [string] before_id
+      # @param [string] limit
+      # @param [string] filter
+      # @param [string] url optional and mutually exclusive from before_id and limit
+      # @return [NgrokAPI::Models::Listable] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-service-users-list
+      def list!(
+        before_id: nil,
+        limit: nil,
+        filter: nil,
+        url: nil
+      )
+        result = @client.list(
+          before_id: before_id,
+          limit: limit,
+          filter: filter,
+          danger: true,
+          url: url,
+          path: PATH
+        )
+
+        NgrokAPI::Models::Listable.new(
+          client: self,
+          attrs: result,
+          list_property: LIST_PROPERTY,
+          klass: NgrokAPI::Models::ServiceUser,
+          danger: true
+        )
+      end
+
+      ##
+      # Update attributes of a service user by ID.
+      #
+      # @param [string] id
+      # @param [string] name human-readable name used to identify the service
+      # @param [boolean] active whether or not the service is active
+      # @return [NgrokAPI::Models::ServiceUser] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-service-users-update
+      def update(id: "", name: nil, active: nil)
+        path = '/service_users/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:name] = name if name
+        data[:active] = active if active
+        result = @client.patch(path % replacements, data: data)
+        NgrokAPI::Models::ServiceUser.new(client: self, attrs: result)
+      end
+
+      ##
+      # Update attributes of a service user by ID.
+      # Throws an exception if API error.
+      #
+      # @param [string] id
+      # @param [string] name human-readable name used to identify the service
+      # @param [boolean] active whether or not the service is active
+      # @return [NgrokAPI::Models::ServiceUser] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-service-users-update
+      def update!(id: "", name: nil, active: nil)
+        path = '/service_users/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:name] = name if name
+        data[:active] = active if active
+        result = @client.patch(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::ServiceUser.new(client: self, attrs: result)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb

@@ -104,7 +104,7 @@ module NgrokAPI
       end
 
       ##
-      # Get detailed information about an SSH Certficate Authority
+      # Get detailed information about an SSH Certificate Authority
       #
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::SSHCertificateAuthority] result from the API request
@@ -121,7 +121,7 @@ module NgrokAPI
       end
 
       ##
-      # Get detailed information about an SSH Certficate Authority
+      # Get detailed information about an SSH Certificate Authority
       # Throws an exception if API error.
       #
       # @param [string] id a resource identifier
@@ -143,6 +143,7 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -150,11 +151,13 @@ module NgrokAPI
       def list(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           url: url,
           path: PATH
         )
@@ -173,6 +176,7 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -180,11 +184,13 @@ module NgrokAPI
       def list!(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           danger: true,
           url: url,
           path: PATH

data/lib/ngrokapi/services/ssh_credentials_client.rb

@@ -33,7 +33,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHCredential] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-credentials-create
-      def create(description: "", metadata: "", acl: [], public_key:, owner_id: nil, owner_email: "")
+      def create(description: "", metadata: "", acl: [], public_key:, owner_id: nil, owner_email: "", scim_user_id: "")
         path = '/ssh_credentials'
         replacements = {
         }
@@ -60,7 +60,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHCredential] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-credentials-create
-      def create!(description: "", metadata: "", acl: [], public_key:, owner_id: nil, owner_email: "")
+      def create!(description: "", metadata: "", acl: [], public_key:, owner_id: nil, owner_email: "", scim_user_id: "")
         path = '/ssh_credentials'
         replacements = {
         }
@@ -145,6 +145,7 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -152,11 +153,13 @@ module NgrokAPI
       def list(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           url: url,
           path: PATH
         )
@@ -175,6 +178,7 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -182,11 +186,13 @@ module NgrokAPI
       def list!(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           danger: true,
           url: url,
           path: PATH

data/lib/ngrokapi/services/ssh_host_certificates_client.rb

@@ -113,7 +113,7 @@ module NgrokAPI
       end
 
       ##
-      # Get detailed information about an SSH Host Certficate
+      # Get detailed information about an SSH Host Certificate
       #
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::SSHHostCertificate] result from the API request
@@ -130,7 +130,7 @@ module NgrokAPI
       end
 
       ##
-      # Get detailed information about an SSH Host Certficate
+      # Get detailed information about an SSH Host Certificate
       # Throws an exception if API error.
       #
       # @param [string] id a resource identifier

data/lib/ngrokapi/services/ssh_user_certificates_client.rb

@@ -121,7 +121,7 @@ module NgrokAPI
       end
 
       ##
-      # Get detailed information about an SSH User Certficate
+      # Get detailed information about an SSH User Certificate
       #
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::SSHUserCertificate] result from the API request
@@ -138,7 +138,7 @@ module NgrokAPI
       end
 
       ##
-      # Get detailed information about an SSH User Certficate
+      # Get detailed information about an SSH User Certificate
       # Throws an exception if API error.
       #
       # @param [string] id a resource identifier

data/lib/ngrokapi/services/tls_certificates_client.rb

@@ -142,6 +142,7 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -149,11 +150,13 @@ module NgrokAPI
       def list(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           url: url,
           path: PATH
         )
@@ -172,6 +175,7 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -179,11 +183,13 @@ module NgrokAPI
       def list!(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           danger: true,
           url: url,
           path: PATH

data/lib/ngrokapi/services/tunnel_sessions_client.rb

@@ -27,6 +27,7 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -34,11 +35,13 @@ module NgrokAPI
       def list(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           url: url,
           path: PATH
         )
@@ -57,6 +60,7 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -64,11 +68,13 @@ module NgrokAPI
       def list!(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           danger: true,
           url: url,
           path: PATH

data/lib/ngrokapi/services/vaults_client.rb

@@ -257,6 +257,7 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -264,11 +265,13 @@ module NgrokAPI
       def list(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           url: url,
           path: PATH
         )
@@ -287,6 +290,7 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -294,11 +298,13 @@ module NgrokAPI
       def list!(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           danger: true,
           url: url,
           path: PATH

data/lib/ngrokapi/version.rb

@@ -4,6 +4,6 @@ module NgrokAPI
   # rubocop:disable Layout/SpaceAroundOperators
 
   # The current version of the gem
-  VERSION="0.26.0".freeze
+  VERSION="0.27.0".freeze
   # rubocop:enable Layout/SpaceAroundOperators
 end

data/spec/ngrokapi/client_spec.rb

@@ -122,6 +122,12 @@ RSpec.describe NgrokAPI::Client do
     end
   end
 
+  describe "#service_users" do
+    it "returns an instance of the ServiceUsersClient" do
+      expect(@client.service_users.class).to eq(NgrokAPI::Services::ServiceUsersClient)
+    end
+  end
+
   describe "#ssh_certificate_authorities" do
     it "returns an instance of the SSHCertificateAuthoritiesClient" do
       expect(@client.ssh_certificate_authorities.class).to eq(NgrokAPI::Services::SSHCertificateAuthoritiesClient)