ngrok-api 0.25.0 → 0.27.0

data/lib/ngrokapi/services/event_subscriptions_client.rb

@@ -136,14 +136,21 @@ 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
       #
       # https://ngrok.com/docs/api#api-event-subscriptions-list
-      def list(before_id: nil, limit: nil, url: nil)
+      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
         )
@@ -162,14 +169,21 @@ 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
       #
       # https://ngrok.com/docs/api#api-event-subscriptions-list
-      def list!(before_id: nil, limit: nil, url: nil)
+      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/failover_backends_client.rb

@@ -141,7 +141,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-failover-backends-list
-      def list(before_id: nil, limit: nil, url: nil)
+      def list(
+        before_id: nil,
+        limit: nil,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -167,7 +171,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-failover-backends-list
-      def list!(before_id: nil, limit: nil, url: nil)
+      def list!(
+        before_id: nil,
+        limit: nil,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,

data/lib/ngrokapi/services/http_response_backends_client.rb

@@ -127,7 +127,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-http-response-backends-list
-      def list(before_id: nil, limit: nil, url: nil)
+      def list(
+        before_id: nil,
+        limit: nil,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -150,7 +154,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-http-response-backends-list
-      def list!(before_id: nil, limit: nil, url: nil)
+      def list!(
+        before_id: nil,
+        limit: nil,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,

data/lib/ngrokapi/services/ip_policies_client.rb

@@ -139,14 +139,21 @@ 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
       #
       # https://ngrok.com/docs/api#api-ip-policies-list
-      def list(before_id: nil, limit: nil, url: nil)
+      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
         )
@@ -165,14 +172,21 @@ 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
       #
       # https://ngrok.com/docs/api#api-ip-policies-list
-      def list!(before_id: nil, limit: nil, url: nil)
+      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/ip_policy_rules_client.rb

@@ -143,14 +143,21 @@ 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
       #
       # https://ngrok.com/docs/api#api-ip-policy-rules-list
-      def list(before_id: nil, limit: nil, url: nil)
+      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
         )
@@ -169,14 +176,21 @@ 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
       #
       # https://ngrok.com/docs/api#api-ip-policy-rules-list
-      def list!(before_id: nil, limit: nil, url: nil)
+      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/ip_restrictions_client.rb

@@ -147,14 +147,21 @@ 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
       #
       # https://ngrok.com/docs/api#api-ip-restrictions-list
-      def list(before_id: nil, limit: nil, url: nil)
+      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,14 +180,21 @@ 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
       #
       # https://ngrok.com/docs/api#api-ip-restrictions-list
-      def list!(before_id: nil, limit: nil, url: nil)
+      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/reserved_addrs_client.rb

@@ -136,14 +136,21 @@ 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
       #
       # https://ngrok.com/docs/api#api-reserved-addrs-list
-      def list(before_id: nil, limit: nil, url: nil)
+      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
         )
@@ -162,14 +169,21 @@ 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
       #
       # https://ngrok.com/docs/api#api-reserved-addrs-list
-      def list!(before_id: nil, limit: nil, url: nil)
+      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/reserved_domains_client.rb

@@ -149,14 +149,21 @@ 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
       #
       # https://ngrok.com/docs/api#api-reserved-domains-list
-      def list(before_id: nil, limit: nil, url: nil)
+      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,14 +182,21 @@ 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
       #
       # https://ngrok.com/docs/api#api-reserved-domains-list
-      def list!(before_id: nil, limit: nil, url: nil)
+      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,14 +198,21 @@ 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
       #
       # https://ngrok.com/docs/api#api-secrets-list
-      def list(before_id: nil, limit: nil, url: nil)
+      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
         )
@@ -220,14 +231,21 @@ 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
       #
       # https://ngrok.com/docs/api#api-secrets-list
-      def list!(before_id: nil, limit: nil, url: nil)
+      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