ngrok-api 0.9.0 → 0.12.0

data/lib/ngrokapi/models/event_target_kinesis.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EventTargetKinesis
+      attr_reader :client,
+        :result,
+        :auth,
+        :stream_arn
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @auth = @result['auth']
+        @stream_arn = @result['stream_arn']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/ip_policy.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class IPPolicy
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :created_at,
+        :description,
+        :metadata,
+        :action
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @uri = @result['uri']
+        @created_at = @result['created_at']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @action = @result['action']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete an IP policy. If the IP policy is referenced by another object for the
+      # purposes of traffic restriction it will be treated as if the IP policy remains
+      # but has zero rules.
+      #
+      # https://ngrok.com/docs/api#api-ip-policies-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update attributes of an IP policy by ID
+      #
+      # https://ngrok.com/docs/api#api-ip-policies-update
+      def update(
+        description: nil,
+        metadata: nil
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/ip_policy_rule.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class IPPolicyRule
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :created_at,
+        :description,
+        :metadata,
+        :cidr,
+        :ip_policy
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @uri = @result['uri']
+        @created_at = @result['created_at']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @cidr = @result['cidr']
+        @ip_policy = @result['ip_policy']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete an IP policy rule.
+      #
+      # https://ngrok.com/docs/api#api-ip-policy-rules-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update attributes of an IP policy rule by ID
+      #
+      # https://ngrok.com/docs/api#api-ip-policy-rules-update
+      def update(
+        description: nil,
+        metadata: nil,
+        cidr: nil
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @cidr = cidr if cidr
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata,
+          cidr: cidr
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/ip_restriction.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class IPRestriction
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :created_at,
+        :description,
+        :metadata,
+        :enforced,
+        :type,
+        :ip_policies
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @uri = @result['uri']
+        @created_at = @result['created_at']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @enforced = @result['enforced']
+        @type = @result['type']
+        @ip_policies = @result['ip_policies']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete an IP restriction
+      #
+      # https://ngrok.com/docs/api#api-ip-restrictions-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/ip_whitelist_entry.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class IPWhitelistEntry
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :created_at,
+        :description,
+        :metadata,
+        :ip_net
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @uri = @result['uri']
+        @created_at = @result['created_at']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @ip_net = @result['ip_net']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete an IP whitelist entry.
+      #
+      # https://ngrok.com/docs/api#api-ip-whitelist-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update attributes of an IP whitelist entry by ID
+      #
+      # https://ngrok.com/docs/api#api-ip-whitelist-update
+      def update(
+        description: nil,
+        metadata: nil
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/ref.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class Ref
+      attr_reader :client,
+        :result,
+        :id,
+        :uri
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @uri = @result['uri']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/reserved_addr.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class ReservedAddr
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :created_at,
+        :description,
+        :metadata,
+        :addr,
+        :region,
+        :endpoint_configuration
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @uri = @result['uri']
+        @created_at = @result['created_at']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @addr = @result['addr']
+        @region = @result['region']
+        @endpoint_configuration = @result['endpoint_configuration']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete a reserved address.
+      #
+      # https://ngrok.com/docs/api#api-reserved-addrs-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/reserved_domain.rb

@@ -1,211 +1,59 @@
-# frozen_string_literal: true
-
-module NgrokAPI
-  module Models
-    ##
-    # A resource representing data from the reserved_domains API
-    class ReservedDomain
-      attr_reader :id,
-        :certificate,
-        :certificate_management_policy,
-        :certificate_management_status,
-        :client,
-        :cname_target,
-        :created_at,
-        :description,
-        :domain,
-        :http_endpoint_configuration,
-        :https_endpoint_configuration,
-        :metadata,
-        :region,
-        :result,
-        :uri
-
-      def initialize(client:, result:)
-        @client = client
-        @result = result
-        @created_at = @result['created_at']
-        @certificate = @result['certificate']
-        @certificate_management_policy = @result['certificate_management_policy']
-        @certificate_management_status = @result['certificate_management_status']
-        @cname_target = @result['cname_target']
-        @description = @result['description']
-        @domain = @result['domain']
-        @http_endpoint_configuration = @result['http_endpoint_configuration']
-        @https_endpoint_configuration = @result['https_endpoint_configuration']
-        @id = @result['id']
-        @metadata = @result['metadata']
-        @region = @result['region']
-        @uri = @result['uri']
-      end
-
-      def ==(other)
-        @result == other.result
-      end
-
-      def to_s
-        @result.to_s
-      end
-
-      ##
-      # Delete this reserved domain.
-      #
-      # @return [nil] result from delete request
-      #
-      # https://ngrok.com/docs/api#api-reserved-domains-delete
-      def delete
-        @client.delete(id: @id)
-      end
-
-      # rubocop:disable LineLength
-
-      ##
-      # Update the attributes of this reserved domain.
-      #
-      # @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 [string] 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 update request
-      #
-      # https://ngrok.com/docs/api#api-reserved-domains-update
-      def update(
-        certificate_id: nil,
-        certificate_management_policy: nil,
-        description: '',
-        http_endpoint_configuration_id: nil,
-        https_endpoint_configuration_id: nil,
-        metadata: ''
-      )
-        if certificate_management_policy
-          @certificate_management_policy = certificate_management_policy
-        end
-        @description = description if description
-        @metadata = metadata if metadata
-        @client.update(
-          id: @id,
-          description: description,
-          metadata: metadata,
-          http_endpoint_configuration_id: http_endpoint_configuration_id,
-          https_endpoint_configuration_id: https_endpoint_configuration_id,
-          certificate_id: certificate_id,
-          certificate_management_policy: certificate_management_policy
-        )
-        # TODO: update @certificate, etc?
-        # @certificate = new_result['certificate'] if certificate_id && new_result['certificate']
-        # if http_endpoint_configuration_id
-        #   @http_endpoint_configuration_id = http_endpoint_configuration_id
-        # end
-        # if https_endpoint_configuration_id
-        #   @https_endpoint_configuration_id = https_endpoint_configuration_id
-        # end
-      end
-      # rubocop:enable LineLength
-
-      ##
-      # Detach the certificate attached from this reserved domain.
-      #
-      # @return [nil] result from delete request
-      #
-      # https://ngrok.com/docs/api#api-reserved-domains-delete-certificate
-      def delete_certificate
-        @certificate = nil
-        @client.delete_certificate(id: @id)
-      end
-
-      ##
-      # Detach the certificate management policy attached from this reserved domain.
-      #
-      # @return [nil] result from delete request
-      #
-      # https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy
-      def delete_certificate_management_policy
-        @certificate_management_policy = nil
-        @certificate_management_status = nil
-        @client.delete_certificate_management_policy(id: @id)
-      end
-
-      ##
-      # Detach the http endpoint configuration attached from this reserved domain.
-      #
-      # @return [nil] result from delete request
-      #
-      # https://ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config
-      def delete_http_endpoint_config
-        @http_endpoint_configuration = nil
-        @client.delete_http_endpoint_config(id: @id)
-      end
-
-      ##
-      # Detach the https endpoint configuration attached from this reserved domain.
-      #
-      # @return [nil] result from delete request
-      #
-      # https://ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config
-      def delete_https_endpoint_config
-        @https_endpoint_configuration = nil
-        @client.delete_https_endpoint_config(id: @id)
-      end
-
-      ##
-      # Restore the certificate attached to this reserved domain.
-      # Only works if the @result is still present from a previous action
-      #
-      # @return [NgrokAPI::Models::ReservedDomain] result from update request
-      #
-      # https://ngrok.com/docs/api#api-reserved-domains-update
-      def restore_certificate
-        @certificate = @result['certificate']
-        @client.update(id: @id, certificate_id: @result['certificate']['id'])
-      end
-
-      ##
-      # Restore the certificate management policy attached to this reserved domain.
-      # Only works if the @result is still present from a previous action
-      #
-      # @return [NgrokAPI::Models::ReservedDomain] result from update request
-      #
-      # https://ngrok.com/docs/api#api-reserved-domains-update
-      def restore_certificate_management_policy
-        @certificate_management_policy = @result['certificate_management_policy']
-        @certificate_management_status = @result['certificate_management_status']
-        @client.update(
-          id: @id,
-          certificate_management_policy: @result['certificate_management_policy']
-        )
-      end
-
-      ##
-      # Restore the http endpoint configuration attached to this reserved domain.
-      # Only works if the @result is still present from a previous action
-      #
-      # @return [NgrokAPI::Models::ReservedDomain] result from update request
-      #
-      # https://ngrok.com/docs/api#api-reserved-domains-update
-      def restore_http_endpoint_config
-        @http_endpoint_configuration = @result['http_endpoint_configuration']
-        @client.update(
-          id: @id,
-          http_endpoint_configuration_id: @result['http_endpoint_configuration']['id']
-        )
-      end
-
-      ##
-      # Restore the https endpoint configuration attached to this reserved domain.
-      # Only works if the @result is still present from a previous action
-      #
-      # @return [NgrokAPI::Models::ReservedDomain] result from update request
-      #
-      # https://ngrok.com/docs/api#api-reserved-domains-update
-      def restore_https_endpoint_config
-        @https_endpoint_configuration = @result['https_endpoint_configuration']
-        @client.update(
-          id: @id,
-          https_endpoint_configuration_id: @result['https_endpoint_configuration']['id']
-        )
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class ReservedDomain
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :created_at,
+        :description,
+        :metadata,
+        :domain,
+        :region,
+        :cname_target,
+        :http_endpoint_configuration,
+        :https_endpoint_configuration,
+        :certificate,
+        :certificate_management_policy,
+        :certificate_management_status
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @uri = @result['uri']
+        @created_at = @result['created_at']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @domain = @result['domain']
+        @region = @result['region']
+        @cname_target = @result['cname_target']
+        @http_endpoint_configuration = @result['http_endpoint_configuration']
+        @https_endpoint_configuration = @result['https_endpoint_configuration']
+        @certificate = @result['certificate']
+        @certificate_management_policy = @result['certificate_management_policy']
+        @certificate_management_status = @result['certificate_management_status']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete a reserved domain.
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/reserved_domain_cert_job.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class ReservedDomainCertJob
+      attr_reader :client,
+        :result,
+        :error_code,
+        :msg,
+        :started_at,
+        :retries_at,
+        :ns_targets
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @error_code = @result['error_code']
+        @msg = @result['msg']
+        @started_at = @result['started_at']
+        @retries_at = @result['retries_at']
+        @ns_targets = @result['ns_targets']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/reserved_domain_cert_ns_target.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class ReservedDomainCertNSTarget
+      attr_reader :client,
+        :result,
+        :zone,
+        :nameservers
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @zone = @result['zone']
+        @nameservers = @result['nameservers']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end