rcs 2.0.5 → 2.0.8

data/lib/rcs/types/attach_webhook_by_id_params.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "webhook_event_enum"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    # Attach a webhook you’ve already created in your account to this phone number.
-    class AttachWebhookByIdParams
-      # @return [String] The unique ID of the webhook you want to attach. This identifier is a string
-      #  that always begins with the prefix `wh_`, for example: `wh_1234567890`.
-      attr_reader :webhook_id
-      # @return [Pinnacle::Types::WebhookEventEnum] Select the event type that will trigger this webhook. <br>
-      #  Set to null if you want to listen to all event types for this phone number. <br>
-      #  Defaults to null.
-      attr_reader :event
-      # @return [OpenStruct] Additional properties unmapped to the current class definition
-      attr_reader :additional_properties
-      # @return [Object]
-      attr_reader :_field_set
-      protected :_field_set
-
-      OMIT = Object.new
-
-      # @param webhook_id [String] The unique ID of the webhook you want to attach. This identifier is a string
-      #  that always begins with the prefix `wh_`, for example: `wh_1234567890`.
-      # @param event [Pinnacle::Types::WebhookEventEnum] Select the event type that will trigger this webhook. <br>
-      #  Set to null if you want to listen to all event types for this phone number. <br>
-      #  Defaults to null.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::AttachWebhookByIdParams]
-      def initialize(webhook_id:, event: OMIT, additional_properties: nil)
-        @webhook_id = webhook_id
-        @event = event if event != OMIT
-        @additional_properties = additional_properties
-        @_field_set = { "webhookId": webhook_id, "event": event }.reject do |_k, v|
-          v == OMIT
-        end
-      end
-
-      # Deserialize a JSON object to an instance of AttachWebhookByIdParams
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::AttachWebhookByIdParams]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        webhook_id = parsed_json["webhookId"]
-        event = parsed_json["event"]
-        new(
-          webhook_id: webhook_id,
-          event: event,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of AttachWebhookByIdParams to a JSON object
-      #
-      # @return [String]
-      def to_json(*_args)
-        @_field_set&.to_json
-      end
-
-      # Leveraged for Union-type generation, validate_raw attempts to parse the given
-      #  hash and check each fields type against the current object's property
-      #  definitions.
-      #
-      # @param obj [Object]
-      # @return [Void]
-      def self.validate_raw(obj:)
-        obj.webhook_id.is_a?(String) != false || raise("Passed value for field obj.webhook_id is not the expected type, validation failed.")
-        obj.event&.is_a?(Pinnacle::Types::WebhookEventEnum) != false || raise("Passed value for field obj.event is not the expected type, validation failed.")
-      end
-    end
-  end
-end

data/lib/rcs/types/attach_webhook_params.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-require_relative "attach_webhook_by_id_params"
-require_relative "create_and_attach_webhook_by_url_params"
-
-module Pinnacle
-  module Types
-    # Use this request to connect a webhook to your phone number and receive real-time
-    #  event notifications.
-    #  You can either attach one of your existing webhooks by providing its ID or
-    #  create a new webhook by specifying its name, URL, and event type.
-    class AttachWebhookParams
-      # Deserialize a JSON object to an instance of AttachWebhookParams
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::AttachWebhookParams]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        begin
-          Pinnacle::Types::AttachWebhookByIdParams.validate_raw(obj: struct)
-          return Pinnacle::Types::AttachWebhookByIdParams.from_json(json_object: struct) unless struct.nil?
-
-          return nil
-        rescue StandardError
-          # noop
-        end
-        begin
-          Pinnacle::Types::CreateAndAttachWebhookByUrlParams.validate_raw(obj: struct)
-          return Pinnacle::Types::CreateAndAttachWebhookByUrlParams.from_json(json_object: struct) unless struct.nil?
-
-          return nil
-        rescue StandardError
-          # noop
-        end
-        struct
-      end
-
-      # Leveraged for Union-type generation, validate_raw attempts to parse the given
-      #  hash and check each fields type against the current object's property
-      #  definitions.
-      #
-      # @param obj [Object]
-      # @return [Void]
-      def self.validate_raw(obj:)
-        begin
-          return Pinnacle::Types::AttachWebhookByIdParams.validate_raw(obj: obj)
-        rescue StandardError
-          # noop
-        end
-        begin
-          return Pinnacle::Types::CreateAndAttachWebhookByUrlParams.validate_raw(obj: obj)
-        rescue StandardError
-          # noop
-        end
-        raise("Passed value matched no type within the union, validation failed.")
-      end
-    end
-  end
-end

data/lib/rcs/types/attach_webhook_response_webhook.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    # Detailed information about the attached webhook.
-    class AttachWebhookResponseWebhook
-      # @return [String] Unique identifier of the webhook within the account. This identifier is a string
-      #  that always begins with the prefix `wh_`, for example: `wh_1234567890`.
-      attr_reader :id
-      # @return [String] Name of the webhook.
-      attr_reader :name
-      # @return [String] The HTTPS endpoint URL where webhook events will be sent as HTTP POST requests.
-      attr_reader :url
-      # @return [String] Secret key used to verify the authenticity of incoming webhook requests. <br>
-      #  This secret key will be stored in the `PINNACLE-SIGNING-SECRET` header.
-      attr_reader :secret
-      # @return [OpenStruct] Additional properties unmapped to the current class definition
-      attr_reader :additional_properties
-      # @return [Object]
-      attr_reader :_field_set
-      protected :_field_set
-
-      OMIT = Object.new
-
-      # @param id [String] Unique identifier of the webhook within the account. This identifier is a string
-      #  that always begins with the prefix `wh_`, for example: `wh_1234567890`.
-      # @param name [String] Name of the webhook.
-      # @param url [String] The HTTPS endpoint URL where webhook events will be sent as HTTP POST requests.
-      # @param secret [String] Secret key used to verify the authenticity of incoming webhook requests. <br>
-      #  This secret key will be stored in the `PINNACLE-SIGNING-SECRET` header.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::AttachWebhookResponseWebhook]
-      def initialize(id:, name:, url:, secret: OMIT, additional_properties: nil)
-        @id = id
-        @name = name
-        @url = url
-        @secret = secret if secret != OMIT
-        @additional_properties = additional_properties
-        @_field_set = { "id": id, "name": name, "url": url, "secret": secret }.reject do |_k, v|
-          v == OMIT
-        end
-      end
-
-      # Deserialize a JSON object to an instance of AttachWebhookResponseWebhook
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::AttachWebhookResponseWebhook]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        id = parsed_json["id"]
-        name = parsed_json["name"]
-        url = parsed_json["url"]
-        secret = parsed_json["secret"]
-        new(
-          id: id,
-          name: name,
-          url: url,
-          secret: secret,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of AttachWebhookResponseWebhook to a JSON object
-      #
-      # @return [String]
-      def to_json(*_args)
-        @_field_set&.to_json
-      end
-
-      # Leveraged for Union-type generation, validate_raw attempts to parse the given
-      #  hash and check each fields type against the current object's property
-      #  definitions.
-      #
-      # @param obj [Object]
-      # @return [Void]
-      def self.validate_raw(obj:)
-        obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
-        obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
-        obj.url.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
-        obj.secret&.is_a?(String) != false || raise("Passed value for field obj.secret is not the expected type, validation failed.")
-      end
-    end
-  end
-end

data/lib/rcs/types/attached_phone_number_result.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "phone_number_campaign_attach_phone_numbers_item"
-require_relative "phone_number_campaign_attach_failed_item"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    class AttachedPhoneNumberResult
-      # @return [Array<Pinnacle::Types::PhoneNumberCampaignAttachPhoneNumbersItem>] List of phone numbers.
-      attr_reader :phone_numbers
-      # @return [Array<Pinnacle::Types::PhoneNumberCampaignAttachFailedItem>] List of numbers that were not failed to be attached.
-      attr_reader :failed
-      # @return [OpenStruct] Additional properties unmapped to the current class definition
-      attr_reader :additional_properties
-      # @return [Object]
-      attr_reader :_field_set
-      protected :_field_set
-
-      OMIT = Object.new
-
-      # @param phone_numbers [Array<Pinnacle::Types::PhoneNumberCampaignAttachPhoneNumbersItem>] List of phone numbers.
-      # @param failed [Array<Pinnacle::Types::PhoneNumberCampaignAttachFailedItem>] List of numbers that were not failed to be attached.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::AttachedPhoneNumberResult]
-      def initialize(phone_numbers:, failed:, additional_properties: nil)
-        @phone_numbers = phone_numbers
-        @failed = failed
-        @additional_properties = additional_properties
-        @_field_set = { "phoneNumbers": phone_numbers, "failed": failed }
-      end
-
-      # Deserialize a JSON object to an instance of AttachedPhoneNumberResult
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::AttachedPhoneNumberResult]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        phone_numbers = parsed_json["phoneNumbers"]&.map do |item|
-          item = item.to_json
-          Pinnacle::Types::PhoneNumberCampaignAttachPhoneNumbersItem.from_json(json_object: item)
-        end
-        failed = parsed_json["failed"]&.map do |item|
-          item = item.to_json
-          Pinnacle::Types::PhoneNumberCampaignAttachFailedItem.from_json(json_object: item)
-        end
-        new(
-          phone_numbers: phone_numbers,
-          failed: failed,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of AttachedPhoneNumberResult to a JSON object
-      #
-      # @return [String]
-      def to_json(*_args)
-        @_field_set&.to_json
-      end
-
-      # Leveraged for Union-type generation, validate_raw attempts to parse the given
-      #  hash and check each fields type against the current object's property
-      #  definitions.
-      #
-      # @param obj [Object]
-      # @return [Void]
-      def self.validate_raw(obj:)
-        obj.phone_numbers.is_a?(Array) != false || raise("Passed value for field obj.phone_numbers is not the expected type, validation failed.")
-        obj.failed.is_a?(Array) != false || raise("Passed value for field obj.failed is not the expected type, validation failed.")
-      end
-    end
-  end
-end

data/lib/rcs/types/audience_count_only.rb

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    class AudienceCountOnly
-      # @return [String] Audience public ID. This identifier is a string that always begins with the
-      #  prefix `aud_`, for example: `aud_abc123`.
-      attr_reader :id
-      # @return [String] Audience name.
-      attr_reader :name
-      # @return [String] Audience description.
-      attr_reader :description
-      # @return [Integer] Total number of contacts in audience.
-      #  Use the [Get Audience](/api-reference/audiences/get) endpoint with the
-      #  pagination parameters to get the audience with its contacts.
-      attr_reader :contact_count
-      # @return [OpenStruct] Additional properties unmapped to the current class definition
-      attr_reader :additional_properties
-      # @return [Object]
-      attr_reader :_field_set
-      protected :_field_set
-
-      OMIT = Object.new
-
-      # @param id [String] Audience public ID. This identifier is a string that always begins with the
-      #  prefix `aud_`, for example: `aud_abc123`.
-      # @param name [String] Audience name.
-      # @param description [String] Audience description.
-      # @param contact_count [Integer] Total number of contacts in audience.
-      #  Use the [Get Audience](/api-reference/audiences/get) endpoint with the
-      #  pagination parameters to get the audience with its contacts.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::AudienceCountOnly]
-      def initialize(id:, name:, description:, contact_count:, additional_properties: nil)
-        @id = id
-        @name = name
-        @description = description
-        @contact_count = contact_count
-        @additional_properties = additional_properties
-        @_field_set = { "id": id, "name": name, "description": description, "contactCount": contact_count }
-      end
-
-      # Deserialize a JSON object to an instance of AudienceCountOnly
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::AudienceCountOnly]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        id = parsed_json["id"]
-        name = parsed_json["name"]
-        description = parsed_json["description"]
-        contact_count = parsed_json["contactCount"]
-        new(
-          id: id,
-          name: name,
-          description: description,
-          contact_count: contact_count,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of AudienceCountOnly to a JSON object
-      #
-      # @return [String]
-      def to_json(*_args)
-        @_field_set&.to_json
-      end
-
-      # Leveraged for Union-type generation, validate_raw attempts to parse the given
-      #  hash and check each fields type against the current object's property
-      #  definitions.
-      #
-      # @param obj [Object]
-      # @return [Void]
-      def self.validate_raw(obj:)
-        obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
-        obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
-        obj.description.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
-        obj.contact_count.is_a?(Integer) != false || raise("Passed value for field obj.contact_count is not the expected type, validation failed.")
-      end
-    end
-  end
-end

data/lib/rcs/types/audience_with_pagination.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "contact"
-require_relative "pagination"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    class AudienceWithPagination
-      # @return [String] Audience public ID. This identifier is a string that always begins with the
-      #  prefix `aud_`, for example: `aud_abc123`.
-      attr_reader :id
-      # @return [String] Audience name.
-      attr_reader :name
-      # @return [String] Audience description.
-      attr_reader :description
-      # @return [Array<Pinnacle::Types::Contact>] Array of contact objects (paginated).
-      attr_reader :contacts
-      # @return [Integer] Total number of contacts in audience.
-      attr_reader :contact_count
-      # @return [Pinnacle::Types::Pagination]
-      attr_reader :pagination
-      # @return [OpenStruct] Additional properties unmapped to the current class definition
-      attr_reader :additional_properties
-      # @return [Object]
-      attr_reader :_field_set
-      protected :_field_set
-
-      OMIT = Object.new
-
-      # @param id [String] Audience public ID. This identifier is a string that always begins with the
-      #  prefix `aud_`, for example: `aud_abc123`.
-      # @param name [String] Audience name.
-      # @param description [String] Audience description.
-      # @param contacts [Array<Pinnacle::Types::Contact>] Array of contact objects (paginated).
-      # @param contact_count [Integer] Total number of contacts in audience.
-      # @param pagination [Pinnacle::Types::Pagination]
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::AudienceWithPagination]
-      def initialize(id:, name:, description:, contacts:, contact_count:, pagination:, additional_properties: nil)
-        @id = id
-        @name = name
-        @description = description
-        @contacts = contacts
-        @contact_count = contact_count
-        @pagination = pagination
-        @additional_properties = additional_properties
-        @_field_set = {
-          "id": id,
-          "name": name,
-          "description": description,
-          "contacts": contacts,
-          "contactCount": contact_count,
-          "pagination": pagination
-        }
-      end
-
-      # Deserialize a JSON object to an instance of AudienceWithPagination
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::AudienceWithPagination]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        id = parsed_json["id"]
-        name = parsed_json["name"]
-        description = parsed_json["description"]
-        contacts = parsed_json["contacts"]&.map do |item|
-          item = item.to_json
-          Pinnacle::Types::Contact.from_json(json_object: item)
-        end
-        contact_count = parsed_json["contactCount"]
-        if parsed_json["pagination"].nil?
-          pagination = nil
-        else
-          pagination = parsed_json["pagination"].to_json
-          pagination = Pinnacle::Types::Pagination.from_json(json_object: pagination)
-        end
-        new(
-          id: id,
-          name: name,
-          description: description,
-          contacts: contacts,
-          contact_count: contact_count,
-          pagination: pagination,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of AudienceWithPagination to a JSON object
-      #
-      # @return [String]
-      def to_json(*_args)
-        @_field_set&.to_json
-      end
-
-      # Leveraged for Union-type generation, validate_raw attempts to parse the given
-      #  hash and check each fields type against the current object's property
-      #  definitions.
-      #
-      # @param obj [Object]
-      # @return [Void]
-      def self.validate_raw(obj:)
-        obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
-        obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
-        obj.description.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
-        obj.contacts.is_a?(Array) != false || raise("Passed value for field obj.contacts is not the expected type, validation failed.")
-        obj.contact_count.is_a?(Integer) != false || raise("Passed value for field obj.contact_count is not the expected type, validation failed.")
-        Pinnacle::Types::Pagination.validate_raw(obj: obj.pagination)
-      end
-    end
-  end
-end

data/lib/rcs/types/autofill_campaign_params.rb

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module Types
-    class AutofillCampaignParams
-      # @return [String] Any additional information you want to provide.
-      attr_reader :additional_info
-      # @return [String] Unique identifier for the campaign.
-      #  - When autofilling 10DLC campaigns, it must begin with the prefix `dlc_` (e.g.,
-      #  `dlc_1234567890`)
-      #  - When autofilling Toll-Free campaigns, it must begin with the prefix `tf_`
-      #  (e.g., `tf_1234567890`)
-      #  - When autofilling RCS campaigns, it must begin with the prefix `rcs_` (e.g.,
-      #  `rcs_1234567890`)
-      attr_reader :campaign_id
-      # @return [OpenStruct] Additional properties unmapped to the current class definition
-      attr_reader :additional_properties
-      # @return [Object]
-      attr_reader :_field_set
-      protected :_field_set
-
-      OMIT = Object.new
-
-      # @param additional_info [String] Any additional information you want to provide.
-      # @param campaign_id [String] Unique identifier for the campaign.
-      #  - When autofilling 10DLC campaigns, it must begin with the prefix `dlc_` (e.g.,
-      #  `dlc_1234567890`)
-      #  - When autofilling Toll-Free campaigns, it must begin with the prefix `tf_`
-      #  (e.g., `tf_1234567890`)
-      #  - When autofilling RCS campaigns, it must begin with the prefix `rcs_` (e.g.,
-      #  `rcs_1234567890`)
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::AutofillCampaignParams]
-      def initialize(additional_info: OMIT, campaign_id: OMIT, additional_properties: nil)
-        @additional_info = additional_info if additional_info != OMIT
-        @campaign_id = campaign_id if campaign_id != OMIT
-        @additional_properties = additional_properties
-        @_field_set = { "additionalInfo": additional_info, "campaignId": campaign_id }.reject do |_k, v|
-          v == OMIT
-        end
-      end
-
-      # Deserialize a JSON object to an instance of AutofillCampaignParams
-      #
-      # @param json_object [String]
-      # @return [Pinnacle::Types::AutofillCampaignParams]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        additional_info = parsed_json["additionalInfo"]
-        campaign_id = parsed_json["campaignId"]
-        new(
-          additional_info: additional_info,
-          campaign_id: campaign_id,
-          additional_properties: struct
-        )
-      end
-
-      # Serialize an instance of AutofillCampaignParams to a JSON object
-      #
-      # @return [String]
-      def to_json(*_args)
-        @_field_set&.to_json
-      end
-
-      # Leveraged for Union-type generation, validate_raw attempts to parse the given
-      #  hash and check each fields type against the current object's property
-      #  definitions.
-      #
-      # @param obj [Object]
-      # @return [Void]
-      def self.validate_raw(obj:)
-        obj.additional_info&.is_a?(String) != false || raise("Passed value for field obj.additional_info is not the expected type, validation failed.")
-        obj.campaign_id&.is_a?(String) != false || raise("Passed value for field obj.campaign_id is not the expected type, validation failed.")
-      end
-    end
-  end
-end