norbelys 0.1.0

data/lib/norbelys/api/programs_api.rb

@@ -0,0 +1,1299 @@
+=begin
+#Norbelys API
+
+#The **Norbelys API** is a single, predictable REST surface for cold email and outreach — people, senders, programs, and sending all live behind the five patterns below. Developer-first and AI-first: every name is either already invented (Schema.org) or obvious.  ## Authentication  Every request authenticates with an **org-scoped API key**. Create one in **Settings → API keys** and send it as a bearer token:  ```http GET https://api.norbelys.com/v1/people Authorization: Bearer ak_live_… ```  Interactive agents may instead use OAuth 2.1 (see `/auth.md` and the `/.well-known/oauth-protected-resource` metadata).  ## Conventions  - **Base URL** — `https://api.norbelys.com/v1`. - **JSON in, JSON out.** Timestamps are ISO-8601 in UTC. - **Cursor pagination.** List endpoints take `limit` + `cursor` and return   `{ data, hasMore, nextCursor }` (offset-paged tables add `page` + `total`). - **Expansions.** Detail GETs take an `expand[]` query param to inline related   data (e.g. `GET /people/{id}?expand[]=timeline`) instead of extra calls. - **Soft deletes.** Anything that has been used is archived, never hard-deleted —   `DELETE` archives the resource and returns it.  ## Errors  Failures return the same envelope on every 4xx/5xx, with the matching HTTP status:  ```json { \"error\": { \"type\": \"invalid_request\", \"code\": \"invalid_param\",             \"message\": \"…\", \"hint\": \"…\", \"doc_url\": \"…\" } } ```  `type` is a broad, machine-routable category derived from the status; `code` is the stable machine contract you branch on (never the human `message`). See the `ApiError` schema.  ## Idempotency  Every `POST` accepts an optional **`Idempotency-Key`** header. Reuse the same key to replay the original result for 24h instead of re-executing — so a retried create can never double-charge or duplicate a record.  ## Rate limits & versioning  Abuse control is enforced at the edge; responses advertise the policy via the `RateLimit-Policy` header, and a `429` carries `Retry-After`. The API is versioned in the URL path (`/v1`). Breaking changes ship under a new version; a retiring surface is announced with `Deprecation` + `Sunset` response headers at least 90 days ahead.
+
+The version of the OpenAPI document: 0.0.1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'cgi'
+
+module Norbelys
+  class ProgramsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Archive a program
+    # Soft-delete the campaign and cancel its in-flight runs. Reversible with programs.restore.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Program]
+    def programs_archive(id, opts = {})
+      data, _status_code, _headers = programs_archive_with_http_info(id, opts)
+      data
+    end
+
+    # Archive a program
+    # Soft-delete the campaign and cancel its in-flight runs. Reversible with programs.restore.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Program, Integer, Hash)>] Program data, response status code and response headers
+    def programs_archive_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProgramsApi.programs_archive ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProgramsApi.programs_archive"
+      end
+      # resource path
+      local_var_path = '/programs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Program'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProgramsApi.programs_archive",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProgramsApi#programs_archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List a program's audience sources
+    # Where this campaign's people came from — one entry per source (segment, group, CSV import, manual), with the people count enrolled from each and whether a segment is kept in continuous sync (dynamic audience).
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [ProgramsAudienceList]
+    def programs_audience_list(id, opts = {})
+      data, _status_code, _headers = programs_audience_list_with_http_info(id, opts)
+      data
+    end
+
+    # List a program&#39;s audience sources
+    # Where this campaign&#39;s people came from — one entry per source (segment, group, CSV import, manual), with the people count enrolled from each and whether a segment is kept in continuous sync (dynamic audience).
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ProgramsAudienceList, Integer, Hash)>] ProgramsAudienceList data, response status code and response headers
+    def programs_audience_list_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProgramsApi.programs_audience_list ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProgramsApi.programs_audience_list"
+      end
+      # resource path
+      local_var_path = '/programs/{id}/audience'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ProgramsAudienceList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProgramsApi.programs_audience_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProgramsApi#programs_audience_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a program
+    # Create a cold-email sequence. Optionally build the WHOLE cadence in one call by passing steps[] (each with inline variants[]); the response returns the program with its steps expanded. Then attach senders, enroll people, and launch.
+    # @param program_create_params [ProgramCreateParams] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @return [ProgramDetail]
+    def programs_create(program_create_params, opts = {})
+      data, _status_code, _headers = programs_create_with_http_info(program_create_params, opts)
+      data
+    end
+
+    # Create a program
+    # Create a cold-email sequence. Optionally build the WHOLE cadence in one call by passing steps[] (each with inline variants[]); the response returns the program with its steps expanded. Then attach senders, enroll people, and launch.
+    # @param program_create_params [ProgramCreateParams] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @return [Array<(ProgramDetail, Integer, Hash)>] ProgramDetail data, response status code and response headers
+    def programs_create_with_http_info(program_create_params, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProgramsApi.programs_create ...'
+      end
+      # verify the required parameter 'program_create_params' is set
+      if @api_client.config.client_side_validation && program_create_params.nil?
+        fail ArgumentError, "Missing the required parameter 'program_create_params' when calling ProgramsApi.programs_create"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ProgramsApi.programs_create, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/programs'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(program_create_params)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ProgramDetail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProgramsApi.programs_create",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProgramsApi#programs_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Enroll people into a program
+    # Add an audience as leads — the union of personIds, a groupId's members, and a segmentId's current matches (omit all to enroll every active person). Never starts sending on its own; call programs.launch to go live.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @option opts [EnrollProgramParams] :enroll_program_params 
+    # @return [EnrollProgramResult]
+    def programs_enroll(id, opts = {})
+      data, _status_code, _headers = programs_enroll_with_http_info(id, opts)
+      data
+    end
+
+    # Enroll people into a program
+    # Add an audience as leads — the union of personIds, a groupId&#39;s members, and a segmentId&#39;s current matches (omit all to enroll every active person). Never starts sending on its own; call programs.launch to go live.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @option opts [EnrollProgramParams] :enroll_program_params 
+    # @return [Array<(EnrollProgramResult, Integer, Hash)>] EnrollProgramResult data, response status code and response headers
+    def programs_enroll_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProgramsApi.programs_enroll ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProgramsApi.programs_enroll"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ProgramsApi.programs_enroll, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/programs/{id}/enroll'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'enroll_program_params'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EnrollProgramResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProgramsApi.programs_enroll",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProgramsApi#programs_enroll\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get an enrollment
+    # @param program_id [String] 
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Enrollment]
+    def programs_enrollments_find(program_id, id, opts = {})
+      data, _status_code, _headers = programs_enrollments_find_with_http_info(program_id, id, opts)
+      data
+    end
+
+    # Get an enrollment
+    # @param program_id [String] 
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Enrollment, Integer, Hash)>] Enrollment data, response status code and response headers
+    def programs_enrollments_find_with_http_info(program_id, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProgramsApi.programs_enrollments_find ...'
+      end
+      # verify the required parameter 'program_id' is set
+      if @api_client.config.client_side_validation && program_id.nil?
+        fail ArgumentError, "Missing the required parameter 'program_id' when calling ProgramsApi.programs_enrollments_find"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProgramsApi.programs_enrollments_find"
+      end
+      # resource path
+      local_var_path = '/programs/{programId}/enrollments/{id}'.sub('{' + 'programId' + '}', CGI.escape(program_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Enrollment'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProgramsApi.programs_enrollments_find",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProgramsApi#programs_enrollments_find\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List a program's leads
+    # The people enrolled in the program and where each sits in the cadence, with per-status counts for the Leads view.
+    # @param program_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor 
+    # @option opts [Boolean] :include_archived 
+    # @option opts [Integer] :limit 
+    # @option opts [String] :dir 
+    # @option opts [Integer] :page 
+    # @option opts [String] :q 
+    # @option opts [String] :sort 
+    # @option opts [Array<String>] :status 
+    # @return [EnrollmentList]
+    def programs_enrollments_list(program_id, opts = {})
+      data, _status_code, _headers = programs_enrollments_list_with_http_info(program_id, opts)
+      data
+    end
+
+    # List a program&#39;s leads
+    # The people enrolled in the program and where each sits in the cadence, with per-status counts for the Leads view.
+    # @param program_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor 
+    # @option opts [Boolean] :include_archived 
+    # @option opts [Integer] :limit 
+    # @option opts [String] :dir 
+    # @option opts [Integer] :page 
+    # @option opts [String] :q 
+    # @option opts [String] :sort 
+    # @option opts [Array<String>] :status 
+    # @return [Array<(EnrollmentList, Integer, Hash)>] EnrollmentList data, response status code and response headers
+    def programs_enrollments_list_with_http_info(program_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProgramsApi.programs_enrollments_list ...'
+      end
+      # verify the required parameter 'program_id' is set
+      if @api_client.config.client_side_validation && program_id.nil?
+        fail ArgumentError, "Missing the required parameter 'program_id' when calling ProgramsApi.programs_enrollments_list"
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ProgramsApi.programs_enrollments_list, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ProgramsApi.programs_enrollments_list, must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["asc", "desc"]
+      if @api_client.config.client_side_validation && opts[:'dir'] && !allowable_values.include?(opts[:'dir'])
+        fail ArgumentError, "invalid value for \"dir\", must be one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ProgramsApi.programs_enrollments_list, must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["created", "updated", "status"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["active", "replied", "bounced", "unsubscribed", "finished", "skipped", "stopped", "cancelled", "paused"]
+      if @api_client.config.client_side_validation && opts[:'status'] && !opts[:'status'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"status\", must include one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/programs/{programId}/enrollments'.sub('{' + 'programId' + '}', CGI.escape(program_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'includeArchived'] = opts[:'include_archived'] if !opts[:'include_archived'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'dir'] = opts[:'dir'] if !opts[:'dir'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'status'] = @api_client.build_collection_param(opts[:'status'], :csv) if !opts[:'status'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EnrollmentList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProgramsApi.programs_enrollments_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProgramsApi#programs_enrollments_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a program
+    # Read one program. Pass expand[]=steps to inline the cadence (each step with its arms) and expand[]=senders for the attached mailboxes.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand 
+    # @return [ProgramDetail]
+    def programs_find(id, opts = {})
+      data, _status_code, _headers = programs_find_with_http_info(id, opts)
+      data
+    end
+
+    # Get a program
+    # Read one program. Pass expand[]&#x3D;steps to inline the cadence (each step with its arms) and expand[]&#x3D;senders for the attached mailboxes.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand 
+    # @return [Array<(ProgramDetail, Integer, Hash)>] ProgramDetail data, response status code and response headers
+    def programs_find_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProgramsApi.programs_find ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProgramsApi.programs_find"
+      end
+      allowable_values = ["steps", "senders"]
+      if @api_client.config.client_side_validation && opts[:'expand'] && !opts[:'expand'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"expand\", must include one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/programs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :csv) if !opts[:'expand'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ProgramDetail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProgramsApi.programs_find",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProgramsApi#programs_find\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Launch a program
+    # The go-live gate — the only path a draft becomes active. Requires at least one live sender, one step, and one enrolled lead. Returns any non-blocking compliance warnings.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @option opts [LaunchProgramParams] :launch_program_params 
+    # @return [LaunchProgramResult]
+    def programs_launch(id, opts = {})
+      data, _status_code, _headers = programs_launch_with_http_info(id, opts)
+      data
+    end
+
+    # Launch a program
+    # The go-live gate — the only path a draft becomes active. Requires at least one live sender, one step, and one enrolled lead. Returns any non-blocking compliance warnings.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @option opts [LaunchProgramParams] :launch_program_params 
+    # @return [Array<(LaunchProgramResult, Integer, Hash)>] LaunchProgramResult data, response status code and response headers
+    def programs_launch_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProgramsApi.programs_launch ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProgramsApi.programs_launch"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ProgramsApi.programs_launch, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/programs/{id}/launch'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'launch_program_params'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'LaunchProgramResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProgramsApi.programs_launch",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProgramsApi#programs_launch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List programs
+    # List the org's campaigns (cold-email sequences), newest first, with per-campaign stats (leads, completion, next send).
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor 
+    # @option opts [Boolean] :include_archived 
+    # @option opts [Integer] :limit 
+    # @option opts [String] :dir 
+    # @option opts [Integer] :page 
+    # @option opts [Boolean] :archived 
+    # @option opts [String] :q 
+    # @option opts [String] :sender_id 
+    # @option opts [String] :sort 
+    # @option opts [Array<String>] :status 
+    # @return [ProgramList]
+    def programs_list(opts = {})
+      data, _status_code, _headers = programs_list_with_http_info(opts)
+      data
+    end
+
+    # List programs
+    # List the org&#39;s campaigns (cold-email sequences), newest first, with per-campaign stats (leads, completion, next send).
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor 
+    # @option opts [Boolean] :include_archived 
+    # @option opts [Integer] :limit 
+    # @option opts [String] :dir 
+    # @option opts [Integer] :page 
+    # @option opts [Boolean] :archived 
+    # @option opts [String] :q 
+    # @option opts [String] :sender_id 
+    # @option opts [String] :sort 
+    # @option opts [Array<String>] :status 
+    # @return [Array<(ProgramList, Integer, Hash)>] ProgramList data, response status code and response headers
+    def programs_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProgramsApi.programs_list ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ProgramsApi.programs_list, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ProgramsApi.programs_list, must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["asc", "desc"]
+      if @api_client.config.client_side_validation && opts[:'dir'] && !allowable_values.include?(opts[:'dir'])
+        fail ArgumentError, "invalid value for \"dir\", must be one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ProgramsApi.programs_list, must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["created", "name", "status"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["draft", "active", "paused", "done"]
+      if @api_client.config.client_side_validation && opts[:'status'] && !opts[:'status'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"status\", must include one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/programs'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'includeArchived'] = opts[:'include_archived'] if !opts[:'include_archived'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'dir'] = opts[:'dir'] if !opts[:'dir'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].nil?
+      query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
+      query_params[:'senderId'] = opts[:'sender_id'] if !opts[:'sender_id'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'status'] = @api_client.build_collection_param(opts[:'status'], :csv) if !opts[:'status'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ProgramList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProgramsApi.programs_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProgramsApi#programs_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Pause a program's sending
+    # Stop sending; messages already queued still complete. Resume with programs.resume.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @return [Program]
+    def programs_pause(id, opts = {})
+      data, _status_code, _headers = programs_pause_with_http_info(id, opts)
+      data
+    end
+
+    # Pause a program&#39;s sending
+    # Stop sending; messages already queued still complete. Resume with programs.resume.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @return [Array<(Program, Integer, Hash)>] Program data, response status code and response headers
+    def programs_pause_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProgramsApi.programs_pause ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProgramsApi.programs_pause"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ProgramsApi.programs_pause, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/programs/{id}/pause'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Program'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProgramsApi.programs_pause",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProgramsApi#programs_pause\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Restore an archived program
+    # Un-archive the campaign and revive the runs the archive cancelled, resuming what's left of the cadence.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @return [Program]
+    def programs_restore(id, opts = {})
+      data, _status_code, _headers = programs_restore_with_http_info(id, opts)
+      data
+    end
+
+    # Restore an archived program
+    # Un-archive the campaign and revive the runs the archive cancelled, resuming what&#39;s left of the cadence.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @return [Array<(Program, Integer, Hash)>] Program data, response status code and response headers
+    def programs_restore_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProgramsApi.programs_restore ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProgramsApi.programs_restore"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ProgramsApi.programs_restore, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/programs/{id}/restore'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Program'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProgramsApi.programs_restore",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProgramsApi#programs_restore\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Resume a paused program
+    # Resume sending from where it stopped — each lead keeps its place in the cadence.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @return [Program]
+    def programs_resume(id, opts = {})
+      data, _status_code, _headers = programs_resume_with_http_info(id, opts)
+      data
+    end
+
+    # Resume a paused program
+    # Resume sending from where it stopped — each lead keeps its place in the cadence.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @return [Array<(Program, Integer, Hash)>] Program data, response status code and response headers
+    def programs_resume_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProgramsApi.programs_resume ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProgramsApi.programs_resume"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ProgramsApi.programs_resume, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/programs/{id}/resume'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Program'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProgramsApi.programs_resume",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProgramsApi#programs_resume\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Attach a sender to a program
+    # Assign a mailbox the program can send from (a program needs at least one to launch).
+    # @param id [String] 
+    # @param add_program_sender_params [AddProgramSenderParams] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @return [ProgramSenderRef]
+    def programs_senders_add(id, add_program_sender_params, opts = {})
+      data, _status_code, _headers = programs_senders_add_with_http_info(id, add_program_sender_params, opts)
+      data
+    end
+
+    # Attach a sender to a program
+    # Assign a mailbox the program can send from (a program needs at least one to launch).
+    # @param id [String] 
+    # @param add_program_sender_params [AddProgramSenderParams] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @return [Array<(ProgramSenderRef, Integer, Hash)>] ProgramSenderRef data, response status code and response headers
+    def programs_senders_add_with_http_info(id, add_program_sender_params, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProgramsApi.programs_senders_add ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProgramsApi.programs_senders_add"
+      end
+      # verify the required parameter 'add_program_sender_params' is set
+      if @api_client.config.client_side_validation && add_program_sender_params.nil?
+        fail ArgumentError, "Missing the required parameter 'add_program_sender_params' when calling ProgramsApi.programs_senders_add"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ProgramsApi.programs_senders_add, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/programs/{id}/senders'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(add_program_sender_params)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ProgramSenderRef'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProgramsApi.programs_senders_add",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProgramsApi#programs_senders_add\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List a program's senders
+    # The mailboxes assigned to this program, each with its pending queue in the program.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [ProgramsSendersList]
+    def programs_senders_list(id, opts = {})
+      data, _status_code, _headers = programs_senders_list_with_http_info(id, opts)
+      data
+    end
+
+    # List a program&#39;s senders
+    # The mailboxes assigned to this program, each with its pending queue in the program.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ProgramsSendersList, Integer, Hash)>] ProgramsSendersList data, response status code and response headers
+    def programs_senders_list_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProgramsApi.programs_senders_list ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProgramsApi.programs_senders_list"
+      end
+      # resource path
+      local_var_path = '/programs/{id}/senders'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ProgramsSendersList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProgramsApi.programs_senders_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProgramsApi#programs_senders_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Detach a sender from a program
+    # Unassign a mailbox. A running campaign refuses to drop its last live sender — pause it first.
+    # @param id [String] 
+    # @param rel_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [DetachResult]
+    def programs_senders_remove(id, rel_id, opts = {})
+      data, _status_code, _headers = programs_senders_remove_with_http_info(id, rel_id, opts)
+      data
+    end
+
+    # Detach a sender from a program
+    # Unassign a mailbox. A running campaign refuses to drop its last live sender — pause it first.
+    # @param id [String] 
+    # @param rel_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DetachResult, Integer, Hash)>] DetachResult data, response status code and response headers
+    def programs_senders_remove_with_http_info(id, rel_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProgramsApi.programs_senders_remove ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProgramsApi.programs_senders_remove"
+      end
+      # verify the required parameter 'rel_id' is set
+      if @api_client.config.client_side_validation && rel_id.nil?
+        fail ArgumentError, "Missing the required parameter 'rel_id' when calling ProgramsApi.programs_senders_remove"
+      end
+      # resource path
+      local_var_path = '/programs/{id}/senders/{relId}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'relId' + '}', CGI.escape(rel_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'DetachResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProgramsApi.programs_senders_remove",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProgramsApi#programs_senders_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Share the campaign report
+    # Mint a public, read-only link to this campaign's report (send it to a client — no account needed). The link is signed and expires after 30 days; archiving the campaign kills it immediately. Mint again for a fresh link.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @return [CampaignReportShare]
+    def programs_share(id, opts = {})
+      data, _status_code, _headers = programs_share_with_http_info(id, opts)
+      data
+    end
+
+    # Share the campaign report
+    # Mint a public, read-only link to this campaign&#39;s report (send it to a client — no account needed). The link is signed and expires after 30 days; archiving the campaign kills it immediately. Mint again for a fresh link.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @return [Array<(CampaignReportShare, Integer, Hash)>] CampaignReportShare data, response status code and response headers
+    def programs_share_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProgramsApi.programs_share ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProgramsApi.programs_share"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ProgramsApi.programs_share, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/programs/{id}/share'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CampaignReportShare'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProgramsApi.programs_share",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProgramsApi#programs_share\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a program
+    # Patch program settings and/or edit the cadence in one call. steps[] is a sparse upsert: an item WITH id edits that step, WITHOUT id creates one, archived:true removes it — same for each step's variants[]. Returns the program with its steps expanded.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [ProgramUpdateParams] :program_update_params 
+    # @return [ProgramDetail]
+    def programs_update(id, opts = {})
+      data, _status_code, _headers = programs_update_with_http_info(id, opts)
+      data
+    end
+
+    # Update a program
+    # Patch program settings and/or edit the cadence in one call. steps[] is a sparse upsert: an item WITH id edits that step, WITHOUT id creates one, archived:true removes it — same for each step&#39;s variants[]. Returns the program with its steps expanded.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [ProgramUpdateParams] :program_update_params 
+    # @return [Array<(ProgramDetail, Integer, Hash)>] ProgramDetail data, response status code and response headers
+    def programs_update_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProgramsApi.programs_update ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProgramsApi.programs_update"
+      end
+      # resource path
+      local_var_path = '/programs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'program_update_params'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ProgramDetail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProgramsApi.programs_update",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProgramsApi#programs_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end