ngrok-api 0.14.0 → 0.17.0

data/lib/ngrokapi/services/reserved_domains_client.rb

@@ -28,23 +28,12 @@ module NgrokAPI
       # @param [string] region reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
       # @param [string] description human-readable description of what this reserved domain will be used for
       # @param [string] metadata arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
-      # @param [string] http_endpoint_configuration_id ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
-      # @param [string] https_endpoint_configuration_id ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
       # @param [string] certificate_id ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with ``certificate_management_policy``.
       # @param [ReservedDomainCertPolicy] certificate_management_policy configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with ``certificate_id``.
       # @return [NgrokAPI::Models::ReservedDomain] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-domains-create
-      def create(
-        name:,
-        region: "",
-        description: "",
-        metadata: "",
-        http_endpoint_configuration_id: nil,
-        https_endpoint_configuration_id: nil,
-        certificate_id: nil,
-        certificate_management_policy: nil
-      )
+      def create(name:, region: "", description: "", metadata: "", http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil)
         path = '/reserved_domains'
         replacements = {
         }
@@ -53,8 +42,6 @@ module NgrokAPI
         data[:region] = region if region
         data[:description] = description if description
         data[:metadata] = metadata if metadata
-        data[:http_endpoint_configuration_id] = http_endpoint_configuration_id if http_endpoint_configuration_id
-        data[:https_endpoint_configuration_id] = https_endpoint_configuration_id if https_endpoint_configuration_id
         data[:certificate_id] = certificate_id if certificate_id
         data[:certificate_management_policy] = certificate_management_policy if certificate_management_policy
         result = @client.post(path % replacements, data: data)
@@ -68,9 +55,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-domains-delete
-      def delete(
-        id: ""
-      )
+      def delete(id: "")
         path = '/reserved_domains/%{id}'
         replacements = {
           id: id,
@@ -86,9 +71,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-domains-delete
-      def delete!(
-        id: ""
-      )
+      def delete!(id: "")
         path = '/reserved_domains/%{id}'
         replacements = {
           id: id,
@@ -103,9 +86,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::ReservedDomain] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-domains-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/reserved_domains/%{id}'
         replacements = {
           id: id,
@@ -123,9 +104,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::ReservedDomain] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-domains-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/reserved_domains/%{id}'
         replacements = {
           id: id,
@@ -144,11 +123,8 @@ module NgrokAPI
       # @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,
+               url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -174,11 +150,8 @@ module NgrokAPI
       # @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,
+                url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -202,22 +175,12 @@ module NgrokAPI
       # @param [string] id
       # @param [string] description human-readable description of what this reserved domain will be used for
       # @param [string] metadata arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
-      # @param [string] http_endpoint_configuration_id ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
-      # @param [string] https_endpoint_configuration_id ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
       # @param [string] certificate_id ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with ``certificate_management_policy``.
       # @param [ReservedDomainCertPolicy] certificate_management_policy configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with ``certificate_id``.
       # @return [NgrokAPI::Models::ReservedDomain] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-domains-update
-      def update(
-        id: "",
-        description: nil,
-        metadata: nil,
-        http_endpoint_configuration_id: nil,
-        https_endpoint_configuration_id: nil,
-        certificate_id: nil,
-        certificate_management_policy: nil
-      )
+      def update(id: "", description: nil, metadata: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil)
         path = '/reserved_domains/%{id}'
         replacements = {
           id: id,
@@ -225,8 +188,6 @@ module NgrokAPI
         data = {}
         data[:description] = description if description
         data[:metadata] = metadata if metadata
-        data[:http_endpoint_configuration_id] = http_endpoint_configuration_id if http_endpoint_configuration_id
-        data[:https_endpoint_configuration_id] = https_endpoint_configuration_id if https_endpoint_configuration_id
         data[:certificate_id] = certificate_id if certificate_id
         data[:certificate_management_policy] = certificate_management_policy if certificate_management_policy
         result = @client.patch(path % replacements, data: data)
@@ -240,22 +201,12 @@ module NgrokAPI
       # @param [string] id
       # @param [string] description human-readable description of what this reserved domain will be used for
       # @param [string] metadata arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
-      # @param [string] http_endpoint_configuration_id ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
-      # @param [string] https_endpoint_configuration_id ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
       # @param [string] certificate_id ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with ``certificate_management_policy``.
       # @param [ReservedDomainCertPolicy] certificate_management_policy configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with ``certificate_id``.
       # @return [NgrokAPI::Models::ReservedDomain] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-domains-update
-      def update!(
-        id: "",
-        description: nil,
-        metadata: nil,
-        http_endpoint_configuration_id: nil,
-        https_endpoint_configuration_id: nil,
-        certificate_id: nil,
-        certificate_management_policy: nil
-      )
+      def update!(id: "", description: nil, metadata: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil)
         path = '/reserved_domains/%{id}'
         replacements = {
           id: id,
@@ -263,8 +214,6 @@ module NgrokAPI
         data = {}
         data[:description] = description if description
         data[:metadata] = metadata if metadata
-        data[:http_endpoint_configuration_id] = http_endpoint_configuration_id if http_endpoint_configuration_id
-        data[:https_endpoint_configuration_id] = https_endpoint_configuration_id if https_endpoint_configuration_id
         data[:certificate_id] = certificate_id if certificate_id
         data[:certificate_management_policy] = certificate_management_policy if certificate_management_policy
         result = @client.patch(path % replacements, data: data, danger: true)
@@ -278,9 +227,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy
-      def delete_certificate_management_policy(
-        id: ""
-      )
+      def delete_certificate_management_policy(id: "")
         path = '/reserved_domains/%{id}/certificate_management_policy'
         replacements = {
           id: id,
@@ -296,9 +243,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy
-      def delete_certificate_management_policy!(
-        id: ""
-      )
+      def delete_certificate_management_policy!(id: "")
         path = '/reserved_domains/%{id}/certificate_management_policy'
         replacements = {
           id: id,
@@ -313,9 +258,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-domains-delete-certificate
-      def delete_certificate(
-        id: ""
-      )
+      def delete_certificate(id: "")
         path = '/reserved_domains/%{id}/certificate'
         replacements = {
           id: id,
@@ -331,85 +274,13 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-domains-delete-certificate
-      def delete_certificate!(
-        id: ""
-      )
+      def delete_certificate!(id: "")
         path = '/reserved_domains/%{id}/certificate'
         replacements = {
           id: id,
         }
         @client.delete(path % replacements, danger: true)
       end
-
-      ##
-      # Detach the http endpoint configuration attached to a reserved domain.
-      #
-      # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::Empty] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config
-      def delete_http_endpoint_config(
-        id: ""
-      )
-        path = '/reserved_domains/%{id}/http_endpoint_configuration'
-        replacements = {
-          id: id,
-        }
-        @client.delete(path % replacements)
-      end
-
-      ##
-      # Detach the http endpoint configuration attached to a reserved domain.
-      # 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-reserved-domains-delete-http-endpoint-config
-      def delete_http_endpoint_config!(
-        id: ""
-      )
-        path = '/reserved_domains/%{id}/http_endpoint_configuration'
-        replacements = {
-          id: id,
-        }
-        @client.delete(path % replacements, danger: true)
-      end
-
-      ##
-      # Detach the https endpoint configuration attached to a reserved domain.
-      #
-      # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::Empty] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config
-      def delete_https_endpoint_config(
-        id: ""
-      )
-        path = '/reserved_domains/%{id}/https_endpoint_configuration'
-        replacements = {
-          id: id,
-        }
-        @client.delete(path % replacements)
-      end
-
-      ##
-      # Detach the https endpoint configuration attached to a reserved domain.
-      # 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-reserved-domains-delete-https-endpoint-config
-      def delete_https_endpoint_config!(
-        id: ""
-      )
-        path = '/reserved_domains/%{id}/https_endpoint_configuration'
-        replacements = {
-          id: id,
-        }
-        @client.delete(path % replacements, danger: true)
-      end
     end
   end
 end

data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb

@@ -30,13 +30,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHCertificateAuthority] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-certificate-authorities-create
-      def create(
-        description: "",
-        metadata: "",
-        private_key_type: "",
-        elliptic_curve: "",
-        key_size: 0
-      )
+      def create(description: "", metadata: "", private_key_type: "", elliptic_curve: "", key_size: 0)
         path = '/ssh_certificate_authorities'
         replacements = {
         }
@@ -57,9 +51,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-certificate-authorities-delete
-      def delete(
-        id: ""
-      )
+      def delete(id: "")
         path = '/ssh_certificate_authorities/%{id}'
         replacements = {
           id: id,
@@ -75,9 +67,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-certificate-authorities-delete
-      def delete!(
-        id: ""
-      )
+      def delete!(id: "")
         path = '/ssh_certificate_authorities/%{id}'
         replacements = {
           id: id,
@@ -92,9 +82,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHCertificateAuthority] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-certificate-authorities-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/ssh_certificate_authorities/%{id}'
         replacements = {
           id: id,
@@ -112,9 +100,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHCertificateAuthority] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-certificate-authorities-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/ssh_certificate_authorities/%{id}'
         replacements = {
           id: id,
@@ -133,11 +119,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-certificate-authorities-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,
@@ -163,11 +146,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-certificate-authorities-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,
@@ -194,11 +174,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHCertificateAuthority] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-certificate-authorities-update
-      def update(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
+      def update(id: "", description: nil, metadata: nil)
         path = '/ssh_certificate_authorities/%{id}'
         replacements = {
           id: id,
@@ -220,11 +196,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHCertificateAuthority] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-certificate-authorities-update
-      def update!(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
+      def update!(id: "", description: nil, metadata: nil)
         path = '/ssh_certificate_authorities/%{id}'
         replacements = {
           id: id,

data/lib/ngrokapi/services/ssh_credentials_client.rb

@@ -30,12 +30,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:
-      )
+      def create(description: "", metadata: "", acl: [], public_key:)
         path = '/ssh_credentials'
         replacements = {
         }
@@ -55,9 +50,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-credentials-delete
-      def delete(
-        id: ""
-      )
+      def delete(id: "")
         path = '/ssh_credentials/%{id}'
         replacements = {
           id: id,
@@ -73,9 +66,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-credentials-delete
-      def delete!(
-        id: ""
-      )
+      def delete!(id: "")
         path = '/ssh_credentials/%{id}'
         replacements = {
           id: id,
@@ -90,9 +81,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHCredential] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-credentials-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/ssh_credentials/%{id}'
         replacements = {
           id: id,
@@ -110,9 +99,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHCredential] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-credentials-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/ssh_credentials/%{id}'
         replacements = {
           id: id,
@@ -131,11 +118,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-credentials-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,
@@ -161,11 +145,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-credentials-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,
@@ -193,12 +174,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHCredential] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-credentials-update
-      def update(
-        id: "",
-        description: nil,
-        metadata: nil,
-        acl: nil
-      )
+      def update(id: "", description: nil, metadata: nil, acl: nil)
         path = '/ssh_credentials/%{id}'
         replacements = {
           id: id,
@@ -222,12 +198,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHCredential] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-credentials-update
-      def update!(
-        id: "",
-        description: nil,
-        metadata: nil,
-        acl: nil
-      )
+      def update!(id: "", description: nil, metadata: nil, acl: nil)
         path = '/ssh_credentials/%{id}'
         replacements = {
           id: id,

data/lib/ngrokapi/services/ssh_host_certificates_client.rb

@@ -33,15 +33,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHHostCertificate] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-host-certificates-create
-      def create(
-        ssh_certificate_authority_id:,
-        public_key:,
-        principals: [],
-        valid_after: "",
-        valid_until: "",
-        description: "",
-        metadata: ""
-      )
+      def create(ssh_certificate_authority_id:, public_key:, principals: [], valid_after: "", valid_until: "", description: "", metadata: "")
         path = '/ssh_host_certificates'
         replacements = {
         }
@@ -64,9 +56,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-host-certificates-delete
-      def delete(
-        id: ""
-      )
+      def delete(id: "")
         path = '/ssh_host_certificates/%{id}'
         replacements = {
           id: id,
@@ -82,9 +72,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-host-certificates-delete
-      def delete!(
-        id: ""
-      )
+      def delete!(id: "")
         path = '/ssh_host_certificates/%{id}'
         replacements = {
           id: id,
@@ -99,9 +87,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHHostCertificate] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-host-certificates-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/ssh_host_certificates/%{id}'
         replacements = {
           id: id,
@@ -119,9 +105,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHHostCertificate] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-host-certificates-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/ssh_host_certificates/%{id}'
         replacements = {
           id: id,
@@ -140,11 +124,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-host-certificates-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,
@@ -170,11 +151,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-host-certificates-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,
@@ -201,11 +179,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHHostCertificate] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-host-certificates-update
-      def update(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
+      def update(id: "", description: nil, metadata: nil)
         path = '/ssh_host_certificates/%{id}'
         replacements = {
           id: id,
@@ -227,11 +201,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHHostCertificate] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-host-certificates-update
-      def update!(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
+      def update!(id: "", description: nil, metadata: nil)
         path = '/ssh_host_certificates/%{id}'
         replacements = {
           id: id,