rcs 2.0.20.pre.rc.3 → 2.0.20.pre.rc.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ba7d9ba5390b5d6626c381e09321c593f9b4dcb787dfcb2d4af2bb1ed6d77b23
4
- data.tar.gz: 4bec3c784d4b39d230481cef0ffd0f4f23603ef93d395ab0b68d4f3c3987968b
3
+ metadata.gz: afc47327e3ddfbf4b091cdca8bc3ac699fd3c915f0bebc32414dc2783e5d0392
4
+ data.tar.gz: e85f4c347460be3b5a7e03ddd876433db2296f4c12492422c89fae7145c81cff
5
5
  SHA512:
6
- metadata.gz: '0944bf2782cd1b0c365b6f1835b5bc742a1c979f969a0e464c8a7d343170800bfd81b94b6732a3dc86e0aeaa57225110493b92141c6ef2fb77cba822cdb1f956'
7
- data.tar.gz: 6f2770fe602aadb266b8df1a9e8451313a091ad704f503a3184162e9d39ec196502e68659fae7d29ec2d515c20c27c21c391776ecb556145ca689cd11f87cf26
6
+ metadata.gz: 3409e11f8c5654be9a46cc90bdebd4c90b8cf881175135ad6ee7ad1dbc43b4c8b29f80e168281d8ed141254193b924add2eb298ed44c7a9bd8a1c59566295535
7
+ data.tar.gz: 7ab68316dece281e439b8e1623b8a050eac5d61badd5c03e38115c68f1d68eb2893f7826fb4eb8c12962bc0779211e0260f351b9fccc723b7cbeb3e191c5097e
data/.fern/metadata.json CHANGED
@@ -8,10 +8,10 @@
8
8
  "useProvidedDefaults": true,
9
9
  "rubocopVariableNumberStyle": "snake_case"
10
10
  },
11
- "originGitCommit": "383d6b59c43597874070074325db9ee4bd58f911",
11
+ "originGitCommit": "1dae99edd696ac539665896a163f1c3dee7c4262",
12
12
  "originGitCommitIsDirty": false,
13
13
  "invokedBy": "ci",
14
- "requestedVersion": "2.0.20.pre.rc.3",
14
+ "requestedVersion": "2.0.20.pre.rc.4",
15
15
  "ciProvider": "github",
16
- "sdkVersion": "2.0.20.pre.rc.3"
16
+ "sdkVersion": "2.0.20.pre.rc.4"
17
17
  }
data/.fern/replay.lock CHANGED
@@ -3,14 +3,14 @@ version: "1.0"
3
3
  generations:
4
4
  - commit_sha: 677e97edc210ae7352691433588e7c5c51130e3c
5
5
  tree_hash: 811e422fb2621b0414257f02d722dd3bb8d76fdb
6
- timestamp: 2026-09-18T21:49:30.155Z
6
+ timestamp: 2026-09-19T03:19:08.752Z
7
7
  cli_version: unknown
8
8
  generator_versions: {}
9
- - commit_sha: caa4d7194b779ef05c20600a1d3da0499b58055a
10
- tree_hash: 4f7d9e328f29a5e6cb7b90c80b1a88aab9d88e01
11
- timestamp: 2026-09-18T21:49:31.069Z
9
+ - commit_sha: 4b00fcbb772dc5119a02a6c8769b0f7a0713a693
10
+ tree_hash: 88eaaff84f6720d7cc86312e2bc33e433d0a4dde
11
+ timestamp: 2026-09-19T03:19:09.666Z
12
12
  cli_version: unknown
13
13
  generator_versions:
14
14
  fernapi/fern-ruby-sdk: 1.12.1
15
- current_generation: caa4d7194b779ef05c20600a1d3da0499b58055a
15
+ current_generation: 4b00fcbb772dc5119a02a6c8769b0f7a0713a693
16
16
  patches: []
@@ -10,7 +10,7 @@ module Pinnacle
10
10
  @raw_client = Pinnacle::Internal::Http::RawClient.new(
11
11
  base_url: base_url || Pinnacle::Environment::DEFAULT,
12
12
  headers: {
13
- "User-Agent" => "rcs/2.0.20.pre.rc.3",
13
+ "User-Agent" => "rcs/2.0.20.pre.rc.4",
14
14
  "X-Fern-Language" => "Ruby",
15
15
  "PINNACLE-API-KEY" => api_key.to_s
16
16
  }
@@ -100,9 +100,11 @@ module Pinnacle
100
100
  # prevents duplicate delivery and charges. If transmission cannot be confirmed, status becomes
101
101
  # `SUBMISSION_UNKNOWN` while Pinnacle reconciles the fax.
102
102
  #
103
- # **Idempotency:** reuse the same `Idempotency-Key` and identical body after a client timeout. The key is scoped
104
- # to your team and covers `from`, `to`, `mediaUrl`, and `quality`. Reusing it with an identical body returns the
105
- # existing logical fax; changing any of those fields returns 409 and never sends another fax.
103
+ # **Idempotency:** `Idempotency-Key` is optional. Without it, each request creates a new fax, including retries.
104
+ # For retry-safe sending, generate a UUID for each intended fax and retain it until the outcome is known. After a
105
+ # client timeout, retry with the same key and identical body. The key is scoped to your team and covers `from`,
106
+ # `to`, `mediaUrl`, and `quality`. Reusing it with an identical body returns the existing fax; changing any of
107
+ # those fields returns 409.
106
108
  #
107
109
  # @param request_options [Hash]
108
110
  # @param params [Pinnacle::Faxes::Types::SendFaxParams]
@@ -111,7 +113,7 @@ module Pinnacle
111
113
  # @option request_options [Hash{String => Object}] :additional_query_parameters
112
114
  # @option request_options [Hash{String => Object}] :additional_body_parameters
113
115
  # @option request_options [Integer] :timeout_in_seconds
114
- # @option params [String] :idempotency_key
116
+ # @option params [String, nil] :idempotency_key
115
117
  #
116
118
  # @return [Pinnacle::Types::Fax]
117
119
  def send_(request_options: {}, **params)
@@ -4,7 +4,7 @@ module Pinnacle
4
4
  module Faxes
5
5
  module Types
6
6
  class SendFaxParams < Internal::Types::Model
7
- field :idempotency_key, -> { String }, optional: false, nullable: false, api_name: "Idempotency-Key"
7
+ field :idempotency_key, -> { String }, optional: true, nullable: false, api_name: "Idempotency-Key"
8
8
 
9
9
  field :from, -> { String }, optional: false, nullable: false
10
10
 
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Pinnacle
4
- VERSION = "2.0.20.pre.rc.3"
4
+ VERSION = "2.0.20.pre.rc.4"
5
5
  end
data/reference.md CHANGED
@@ -3083,7 +3083,7 @@ Send one PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, or TXT document from a configured
3083
3083
 
3084
3084
  **Delivery uncertainty:** Pinnacle does not automatically retry a fax after transmission may have started, which prevents duplicate delivery and charges. If transmission cannot be confirmed, status becomes `SUBMISSION_UNKNOWN` while Pinnacle reconciles the fax.
3085
3085
 
3086
- **Idempotency:** reuse the same `Idempotency-Key` and identical body after a client timeout. The key is scoped to your team and covers `from`, `to`, `mediaUrl`, and `quality`. Reusing it with an identical body returns the existing logical fax; changing any of those fields returns 409 and never sends another fax.
3086
+ **Idempotency:** `Idempotency-Key` is optional. Without it, each request creates a new fax, including retries. For retry-safe sending, generate a UUID for each intended fax and retain it until the outcome is known. After a client timeout, retry with the same key and identical body. The key is scoped to your team and covers `from`, `to`, `mediaUrl`, and `quality`. Reusing it with an identical body returns the existing fax; changing any of those fields returns 409.
3087
3087
  </dd>
3088
3088
  </dl>
3089
3089
  </dd>
@@ -3099,7 +3099,6 @@ Send one PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, or TXT document from a configured
3099
3099
 
3100
3100
  ```ruby
3101
3101
  client.faxes.send_(
3102
- idempotency_key: "Idempotency-Key",
3103
3102
  from: "from",
3104
3103
  to: "to",
3105
3104
  media_url: "mediaUrl"
@@ -3118,7 +3117,7 @@ client.faxes.send_(
3118
3117
  <dl>
3119
3118
  <dd>
3120
3119
 
3121
- **idempotency_key:** `String` — Unique key for one logical send. Use 1–128 ASCII letters, numbers, periods, underscores, or hyphens. Reuse it only with the identical `from`, `to`, `mediaUrl`, and effective `quality`; any change returns 409.
3120
+ **idempotency_key:** `String` — Optional unique key for one logical send. Without it, every request creates a new fax. Use 1–128 ASCII letters, numbers, periods, underscores, or hyphens. Reuse it only with the identical `from`, `to`, `mediaUrl`, and effective `quality`; any change returns 409.
3122
3121
 
3123
3122
  </dd>
3124
3123
  </dl>
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rcs
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.20.pre.rc.3
4
+ version: 2.0.20.pre.rc.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Pinnacle
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2026-09-18 00:00:00.000000000 Z
11
+ date: 2026-09-19 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description: The Pinnacle Ruby library provides convenient access to the Pinnacle
14
14
  API from Ruby.